Enum CameraIndex

pub enum CameraIndex {
    Index(u32),
    String(String),
}

Describes the index of the camera.

• Index: A numbered index
• String: A string, used for IPCameras.

Variants

Index(u32)

String(String)

Implementations

impl CameraIndex

pub fn as_index(&self) -> Result<u32, NokhwaError>

Turns this value into a number. If it is a string, it will attempt to parse it as a u32.

Errors

Fails if the value is not a number.

pub fn as_string(&self) -> String

Turns this value into a String. If it is a number, it will be automatically converted.

pub fn is_index(&self) -> bool

Returns true if this CameraIndex contains an CameraIndex::Index

pub fn is_string(&self) -> bool

Returns true if this CameraIndex contains an CameraIndex::String

Trait Implementations

impl Clone for CameraIndex

fn clone(&self) -> CameraIndex

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CameraIndex

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for CameraIndex

fn default() -> CameraIndex

Returns the “default value” for a type.

impl Display for CameraIndex

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Hash for CameraIndex

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CameraIndex

fn cmp(&self, other: &CameraIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CameraIndex

fn eq(&self, other: &CameraIndex) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CameraIndex

fn partial_cmp(&self, other: &CameraIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<CameraIndex> for u32

type Error = NokhwaError

The type returned in the event of a conversion error.

fn try_from( value: CameraIndex, ) -> Result<u32, <u32 as TryFrom<CameraIndex>>::Error>

Performs the conversion.

impl TryFrom<CameraIndex> for usize

type Error = NokhwaError

The type returned in the event of a conversion error.

fn try_from( value: CameraIndex, ) -> Result<usize, <usize as TryFrom<CameraIndex>>::Error>

Performs the conversion.

impl Eq for CameraIndex

impl StructuralPartialEq for CameraIndex