Skip to main content

Discriminant

Struct Discriminant 

1.21.0 · Source
pub struct Discriminant<T>(<T as DiscriminantKind>::Discriminant);
Expand description

Opaque type representing the discriminant of an enum.

See the discriminant function in this module for more information.

Tuple Fields§

§0: <T as DiscriminantKind>::Discriminant

Implementations§

Source§

impl<T> Discriminant<T>

Source

pub const fn ord(&self) -> DiscriminantOrd<T>

🔬This is a nightly-only experimental API. (discriminant_ord)

Returns an ordering key for this Discriminant that has an unstable implementation with regards to semantic versioning. This is not the be confused with an [“unstable sort”].

Because all types have a publicly accessible Discriminant, regardless of whether the order of said type is a part of its stability guarantees, the exact ordering of the returned DiscriminantOrd cannot be relied on for stability across crates. This is similar to the stability of the size of a type as returned by size_of.

Enum values will be ordered based on the source declaration and repr values of their variants, consistent with derived implementations of PartialOrd and Ord. Noting that only the discriminant and no field values are considered. All other kinds of values have an unspecified ordering, but will typically be trivially ordered as equivalent.

Users of this function should instead rely on the Ord implementation of T wherever possible.

§Examples
#![feature(discriminant_ord)]

use std::cmp::Ordering;
use std::mem::discriminant;

enum Foo { A(i32), B(i32) }

// Equivalent arms will compare equal regardless of contained data
assert_matches!(
    discriminant(&Foo::A(1)).ord().cmp(&discriminant(&Foo::A(2)).ord()),
    Ordering::Equal,
);

// Inequivalent arms will compare not-equal
assert_matches!(
    discriminant(&Foo::A(1)).ord().cmp(&discriminant(&Foo::B(1)).ord()),
    Ordering::Less | Ordering::Greater,
);

Upstream libraries and the compiler are free to change the exact ordering of discriminants. The below may break at any time:

ⓘ
// Foo::A is declared before Foo::B, but that ordering is not stable
assert_matches!(
    discriminant(&Foo::A(0)).ord().cmp(&discriminant(&Foo::B(0)).ord()),
    Ordering::Less,
);

Trait Implementations§

1.21.0 · Source§

impl<T> Clone for Discriminant<T>

Source§

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

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
1.21.0 · Source§

impl<T> Copy for Discriminant<T>

1.21.0 · Source§

impl<T> Debug for Discriminant<T>

Source§

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

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

impl<T> Eq for Discriminant<T>

1.21.0 · Source§

impl<T> Hash for Discriminant<T>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
1.21.0 · Source§

impl<T> PartialEq for Discriminant<T>

Source§

fn eq(&self, rhs: &Discriminant<T>) -> bool

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

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

Inequality operator !=. Read more

Auto Trait Implementations§

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PossiblyOption<T> for T

Source§

fn to_option(self) -> Option<T>

Convert this object into an Option<T>
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more