Enum InputSource

#[repr(u8)]
pub enum InputSource {
    DisplayPort1 = 15,
    DisplayPort2 = 16,
    Hdmi1 = 17,
    Hdmi2 = 18,
    UsbC1 = 25,
    UsbC2 = 27,
}

An input source value. See also InputSourceRaw.

Variants

DisplayPort1 = 15

DisplayPort2 = 16

Hdmi1 = 17

Hdmi2 = 18

UsbC1 = 25

UsbC2 = 27

Implementations

impl InputSource

pub const fn from_repr(discriminant: u8) -> Option<InputSource>

Try to create Self from the raw representation

impl InputSource

pub fn as_raw(self) -> InputSourceRaw

Get InputSourceRaw.

assert_eq!(InputSource::Hdmi1.as_raw(), 17);

pub fn raw_from_str(input: &str) -> Result<InputSourceRaw>

Get InputSourceRaw from a string. The string is either the name of an InputSource or a number.

Examples

// Input strings are either an [`InputSource`] or a number.
assert_eq!(
    InputSource::raw_from_str("Hdmi1").unwrap(),
    InputSource::Hdmi1.as_raw()
);
assert_eq!(InputSource::raw_from_str("27").unwrap(), 27);

// Undefined string will be an error.
assert!(InputSource::raw_from_str("xyz").is_err());
// The error message should contain the original string.
assert!(
    InputSource::raw_from_str("xyz")
        .unwrap_err()
        .to_string()
        .contains("xyz")
);

pub fn str_from_raw(value: InputSourceRaw) -> String

Get a string from InputSourceRaw.

Examples

assert_eq!(InputSource::str_from_raw(InputSource::Hdmi1.as_raw()), "Hdmi1");
assert_eq!(InputSource::str_from_raw(17), "Hdmi1");
assert_eq!(InputSource::str_from_raw(255), "255");

Trait Implementations

impl AsRef<str> for InputSource

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for InputSource

fn clone(&self) -> InputSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputSource

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

Formats the value using the given formatter.

impl FromStr for InputSource

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<InputSource, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for InputSource

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

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

const 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 TryFrom<&str> for InputSource

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<InputSource, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for InputSource

impl StructuralPartialEq for InputSource