Struct Variant

pub struct Variant<T: Debug> { /* private fields */ }

Provides runtime specialized representation of Enumeration.

To avoid using dyn for mixing Enumeration, you can use Variant with a trade-off for having to try casting before using it.

Examples

enumerate!(Foo(u8)
    Bar
    Baz
);

enumerate!(Color(u8)
    Red
    Green
    Blue
);

let mut vec: Vec<Variant<u8>> = vec![Foo::Bar.into(), Color::Green.into(), Foo::Baz.into()]; // Variant::new(Foo::Bar) or Variant::from(Foo::Bar) works too

assert_eq!(vec[0].cast::<Foo>(), Ok(Foo::Bar));
assert!(vec[1].cast::<Foo>().is_err());

Implementations

impl<T: Debug> Variant<T>

pub fn new<E: Enumeration>(e: E) -> Variant<E::Index>

Construct Variant with Enumeration

pub fn type_id(self) -> TypeId

Returns the type id of the enumeration.

pub fn index(self) -> T

Returns the index of the enumeration.

pub fn cast<E: Enumeration<Index = T>>(self) -> Result<E, CastError<E>>

Try casting to the given generic parameter

Trait Implementations

impl<T: Clone + Debug> Clone for Variant<T>

fn clone(&self) -> Variant<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Debug> Debug for Variant<T>

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

Formats the value using the given formatter.

impl<T: Enumeration> From<T> for Variant<T::Index>

fn from(e: T) -> Self

Converts to this type from the input type.

impl<T: Hash + Debug> Hash for Variant<T>

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

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<T: Ord + Debug> Ord for Variant<T>

fn cmp(&self, other: &Variant<T>) -> 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<T: PartialEq + Debug> PartialEq for Variant<T>

fn eq(&self, other: &Variant<T>) -> 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<T: PartialOrd + Debug> PartialOrd for Variant<T>

fn partial_cmp(&self, other: &Variant<T>) -> 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<T: Copy + Debug> Copy for Variant<T>

impl<T: Eq + Debug> Eq for Variant<T>

impl<T: Debug> StructuralPartialEq for Variant<T>