Skip to main content

Ident

Enum Ident 

Source
pub enum Ident<T, Repr> {
    Known(T),
    Reserved(Repr),
}
Expand description

A container that holds either a known variant, or an integer value with unknown meaning.

§Example

#[repr(u8)]
enum KnownColor {
    Red = 0,
    Green = 1,
    Blue = 2,
}

// This can be autogenerated using something like `num_enum::TryFromPrimitive`.
impl TryFrom<u8> for KnownColor {
    type Error = Unrecognized;

    fn try_from(value: u8) -> Result<Self, Self::Error> {
        match value {
            0 => Ok(KnownColor::Red),
            1 => Ok(KnownColor::Green),
            2 => Ok(KnownColor::Blue),
            _ => Err(Unrecognized),
        }
    }
}
struct Unrecognized;

type Color = Ident<KnownColor, u8>;

let green = Color::from_integer(1);
assert!(matches!(green, Color::Known(KnownColor::Green)));

let orange = Color::from_integer(5);
assert!(matches!(orange, Color::Reserved(5)));

Variants§

§

Known(T)

A well-known value.

§

Reserved(Repr)

A reserved value.

This can be used to identify vendor-specific types.

Implementations§

Source§

impl<T, Repr> Ident<T, Repr>

Source

pub fn is_reserved(&self) -> bool

Test if the value is reserved.

Source§

impl<T, Repr> Ident<T, Repr>
where T: TryFrom<Repr>, Repr: Clone + Copy,

Source

pub fn from_integer(value: Repr) -> Self

Try to decode a known identifier; if that fails store the raw number as a “reserved” value.

Source§

impl<T, Repr> Ident<T, Repr>
where T: Into<Repr>,

Source

pub fn to_integer(self) -> Repr

Convert the identifier to an integer.

Trait Implementations§

Source§

impl<T: Clone, Repr: Clone> Clone for Ident<T, Repr>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Copy, Repr: Copy> Copy for Ident<T, Repr>

Source§

impl<T, Repr> Debug for Ident<T, Repr>
where T: Clone + Copy + PartialEq + Debug, Repr: Clone + Copy + PartialEq + Debug + UpperHex,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T, Repr> From<T> for Ident<T, Repr>

Conversion from the “known” type to the Ident::Known variant.

Source§

fn from(value: T) -> Self

Converts to this type from the input type.
Source§

impl<T: PartialEq, Repr: PartialEq> PartialEq for Ident<T, Repr>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<T: PartialEq, Repr: PartialEq> StructuralPartialEq for Ident<T, Repr>

Auto Trait Implementations§

§

impl<T, Repr> Freeze for Ident<T, Repr>
where T: Freeze, Repr: Freeze,

§

impl<T, Repr> RefUnwindSafe for Ident<T, Repr>
where T: RefUnwindSafe, Repr: RefUnwindSafe,

§

impl<T, Repr> Send for Ident<T, Repr>
where T: Send, Repr: Send,

§

impl<T, Repr> Sync for Ident<T, Repr>
where T: Sync, Repr: Sync,

§

impl<T, Repr> Unpin for Ident<T, Repr>
where T: Unpin, Repr: Unpin,

§

impl<T, Repr> UnsafeUnpin for Ident<T, Repr>
where T: UnsafeUnpin, Repr: UnsafeUnpin,

§

impl<T, Repr> UnwindSafe for Ident<T, Repr>
where T: UnwindSafe, Repr: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.