Enum Oneof

#[non_exhaustive]
pub enum Oneof<const LEN: usize, _0 = (), _1 = (), _2 = (), _3 = (), _4 = (), _5 = (), _6 = (), _7 = (), _8 = (), _9 = (), _10 = (), _11 = ()> {
    _0(_0),
    _1(_1),
    _2(_2),
    _3(_3),
    _4(_4),
    _5(_5),
    _6(_6),
    _7(_7),
    _8(_8),
    _9(_9),
    _10(_10),
    _11(_11),
}

A generic, parameterized enum for expressing structured alternatives.

Variants are expected to be contiguous, meaning () (unit types) should only appear at the end.

The first variant (A) is considered the default, implementing Default when A: Default.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

_0(_0)

The 1st variant.

_1(_1)

The 2nd variant.

_2(_2)

The 3rd variant.

_3(_3)

The 4th variant.

_4(_4)

The 5th variant.

_5(_5)

The 6th variant.

_6(_6)

The 7th variant.

_7(_7)

The 8th variant.

_8(_8)

The 9th variant.

_9(_9)

The 10th variant.

_10(_10)

The 11th variant.

_11(_11)

The 12th variant.

Implementations

impl<const LEN: usize, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

Structural methods.

pub const LEN: usize

The number of active (non-() type) variants.

pub const MAX_ARITY: usize = 12usize

The maximum number of generic type parameters in this enum.

pub const fn variant_index(&self) -> usize

Returns the current variant index (0-based).

pub const fn is_variant_index(&self, index: usize) -> bool

Checks whether the current variant is at index (0-based).

pub const fn variant_name(&self) -> &'static str

Returns the current variant name.

pub const fn is_variant_name(&self, name: &str) -> bool

Checks whether the current variant has the given name.

impl<const LEN: usize, _0: 'static, _1: 'static, _2: 'static, _3: 'static, _4: 'static, _5: 'static, _6: 'static, _7: 'static, _8: 'static, _9: 'static, _10: 'static, _11: 'static> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

pub fn first_non_unit() -> Option<&'static str>

Returns the first non-unit variant name, if any.

pub fn validate() -> bool

Validates that inactive () variants only appear at the end, and that LEN equals the number of active variants.

impl<const LEN: usize, _0: Clone, _1: Clone, _2: Clone, _3: Clone, _4: Clone, _5: Clone, _6: Clone, _7: Clone, _8: Clone, _9: Clone, _10: Clone, _11: Clone> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

Conversion methods.

pub fn into_tuple_options( self, ) -> (Option<_0>, Option<_1>, Option<_2>, Option<_3>, Option<_4>, Option<_5>, Option<_6>, Option<_7>, Option<_8>, Option<_9>, Option<_10>, Option<_11>)

Returns a tuple with Some(value) for the active variant and None elsewhere.

pub fn into_tuple_defaults( self, ) -> (_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11)

where _0: Default, _1: Default, _2: Default, _3: Default, _4: Default, _5: Default, _6: Default, _7: Default, _8: Default, _9: Default, _10: Default, _11: Default,

Returns a tuple with the active variant’s inner value in its corresponding position and Default::default() for all others.

impl<const LEN: usize, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

pub fn as_tuple_ref_options( &self, ) -> (Option<&_0>, Option<&_1>, Option<&_2>, Option<&_3>, Option<&_4>, Option<&_5>, Option<&_6>, Option<&_7>, Option<&_8>, Option<&_9>, Option<&_10>, Option<&_11>)

Returns a tuple with Some(&value) for the active variant and None elsewhere.

impl<const LEN: usize, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

Variant-specific methods.

pub const fn is_0(&self) -> bool

Returns true if there’s a value in variant _0 (The 1st).

pub fn into_0(self) -> Option<_0>

Returns the owned value in variant _0, if present.

pub fn as_ref_0(&self) -> Option<&_0>

Returns a reference to the inner value in variant _0, if present.

pub fn as_mut_0(&mut self) -> Option<&mut _0>

Returns a reference to the inner value in variant_0, if present.

---

pub const fn is_1(&self) -> bool

Returns true if there’s a value in variant _1 (The 2nd).

pub fn into_1(self) -> Option<_1>

Returns the owned value in variant _1, if present.

pub fn as_ref_1(&self) -> Option<&_1>

Returns a reference to the inner value in variant _1, if present.

pub fn as_mut_1(&mut self) -> Option<&mut _1>

Returns a reference to the inner value in variant_1, if present.

---

pub const fn is_2(&self) -> bool

Returns true if there’s a value in variant _2 (The 3rd).

pub fn into_2(self) -> Option<_2>

Returns the owned value in variant _2, if present.

pub fn as_ref_2(&self) -> Option<&_2>

Returns a reference to the inner value in variant _2, if present.

pub fn as_mut_2(&mut self) -> Option<&mut _2>

Returns a reference to the inner value in variant_2, if present.

---

pub const fn is_3(&self) -> bool

Returns true if there’s a value in variant _3 (The 4th).

pub fn into_3(self) -> Option<_3>

Returns the owned value in variant _3, if present.

pub fn as_ref_3(&self) -> Option<&_3>

Returns a reference to the inner value in variant _3, if present.

pub fn as_mut_3(&mut self) -> Option<&mut _3>

Returns a reference to the inner value in variant_3, if present.

---

pub const fn is_4(&self) -> bool

Returns true if there’s a value in variant _4 (The 5th).

pub fn into_4(self) -> Option<_4>

Returns the owned value in variant _4, if present.

pub fn as_ref_4(&self) -> Option<&_4>

Returns a reference to the inner value in variant _4, if present.

pub fn as_mut_4(&mut self) -> Option<&mut _4>

Returns a reference to the inner value in variant_4, if present.

---

pub const fn is_5(&self) -> bool

Returns true if there’s a value in variant _5 (The 6th).

pub fn into_5(self) -> Option<_5>

Returns the owned value in variant _5, if present.

pub fn as_ref_5(&self) -> Option<&_5>

Returns a reference to the inner value in variant _5, if present.

pub fn as_mut_5(&mut self) -> Option<&mut _5>

Returns a reference to the inner value in variant_5, if present.

---

pub const fn is_6(&self) -> bool

Returns true if there’s a value in variant _6 (The 7th).

pub fn into_6(self) -> Option<_6>

Returns the owned value in variant _6, if present.

pub fn as_ref_6(&self) -> Option<&_6>

Returns a reference to the inner value in variant _6, if present.

pub fn as_mut_6(&mut self) -> Option<&mut _6>

Returns a reference to the inner value in variant_6, if present.

---

pub const fn is_7(&self) -> bool

Returns true if there’s a value in variant _7 (The 8th).

pub fn into_7(self) -> Option<_7>

Returns the owned value in variant _7, if present.

pub fn as_ref_7(&self) -> Option<&_7>

Returns a reference to the inner value in variant _7, if present.

pub fn as_mut_7(&mut self) -> Option<&mut _7>

Returns a reference to the inner value in variant_7, if present.

---

pub const fn is_8(&self) -> bool

Returns true if there’s a value in variant _8 (The 9th).

pub fn into_8(self) -> Option<_8>

Returns the owned value in variant _8, if present.

pub fn as_ref_8(&self) -> Option<&_8>

Returns a reference to the inner value in variant _8, if present.

pub fn as_mut_8(&mut self) -> Option<&mut _8>

Returns a reference to the inner value in variant_8, if present.

---

pub const fn is_9(&self) -> bool

Returns true if there’s a value in variant _9 (The 10th).

pub fn into_9(self) -> Option<_9>

Returns the owned value in variant _9, if present.

pub fn as_ref_9(&self) -> Option<&_9>

Returns a reference to the inner value in variant _9, if present.

pub fn as_mut_9(&mut self) -> Option<&mut _9>

Returns a reference to the inner value in variant_9, if present.

---

pub const fn is_10(&self) -> bool

Returns true if there’s a value in variant _10 (The 11th).

pub fn into_10(self) -> Option<_10>

Returns the owned value in variant _10, if present.

pub fn as_ref_10(&self) -> Option<&_10>

Returns a reference to the inner value in variant _10, if present.

pub fn as_mut_10(&mut self) -> Option<&mut _10>

Returns a reference to the inner value in variant_10, if present.

---

pub const fn is_11(&self) -> bool

Returns true if there’s a value in variant _11 (The 12th).

pub fn into_11(self) -> Option<_11>

Returns the owned value in variant _11, if present.

pub fn as_ref_11(&self) -> Option<&_11>

Returns a reference to the inner value in variant _11, if present.

pub fn as_mut_11(&mut self) -> Option<&mut _11>

Returns a reference to the inner value in variant_11, if present.

---

pub fn map_0<NEW>( self, f: impl FnOnce(_0) -> NEW, ) -> Oneof<LEN, NEW, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

Transforms the inner value in variant_0 using f, leaving other variants unchanged.

pub fn map_1<NEW>( self, f: impl FnOnce(_1) -> NEW, ) -> Oneof<LEN, _0, NEW, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

Transforms the inner value in variant_1 using f, leaving other variants unchanged.

pub fn map_2<NEW>( self, f: impl FnOnce(_2) -> NEW, ) -> Oneof<LEN, _0, _1, NEW, _3, _4, _5, _6, _7, _8, _9, _10, _11>

Transforms the inner value in variant_2 using f, leaving other variants unchanged.

pub fn map_3<NEW>( self, f: impl FnOnce(_3) -> NEW, ) -> Oneof<LEN, _0, _1, _2, NEW, _4, _5, _6, _7, _8, _9, _10, _11>

Transforms the inner value in variant_3 using f, leaving other variants unchanged.

pub fn map_4<NEW>( self, f: impl FnOnce(_4) -> NEW, ) -> Oneof<LEN, _0, _1, _2, _3, NEW, _5, _6, _7, _8, _9, _10, _11>

Transforms the inner value in variant_4 using f, leaving other variants unchanged.

pub fn map_5<NEW>( self, f: impl FnOnce(_5) -> NEW, ) -> Oneof<LEN, _0, _1, _2, _3, _4, NEW, _6, _7, _8, _9, _10, _11>

Transforms the inner value in variant_5 using f, leaving other variants unchanged.

pub fn map_6<NEW>( self, f: impl FnOnce(_6) -> NEW, ) -> Oneof<LEN, _0, _1, _2, _3, _4, _5, NEW, _7, _8, _9, _10, _11>

Transforms the inner value in variant_6 using f, leaving other variants unchanged.

pub fn map_7<NEW>( self, f: impl FnOnce(_7) -> NEW, ) -> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, NEW, _8, _9, _10, _11>

Transforms the inner value in variant_7 using f, leaving other variants unchanged.

pub fn map_8<NEW>( self, f: impl FnOnce(_8) -> NEW, ) -> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, NEW, _9, _10, _11>

Transforms the inner value in variant_8 using f, leaving other variants unchanged.

pub fn map_9<NEW>( self, f: impl FnOnce(_9) -> NEW, ) -> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, NEW, _10, _11>

Transforms the inner value in variant_9 using f, leaving other variants unchanged.

pub fn map_10<NEW>( self, f: impl FnOnce(_10) -> NEW, ) -> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, NEW, _11>

Transforms the inner value in variant_10 using f, leaving other variants unchanged.

pub fn map_11<NEW>( self, f: impl FnOnce(_11) -> NEW, ) -> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, NEW>

Transforms the inner value in variant_11 using f, leaving other variants unchanged.

Trait Implementations

impl<const LEN: usize, _0: Clone, _1: Clone, _2: Clone, _3: Clone, _4: Clone, _5: Clone, _6: Clone, _7: Clone, _8: Clone, _9: Clone, _10: Clone, _11: Clone> Clone for Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

fn clone(&self) -> Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const LEN: usize, _0: ConstDefault, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11> ConstDefault for Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

const DEFAULT: Self

Returns the compile-time “default value” for a type.

impl<const LEN: usize, _0: Debug, _1: Debug, _2: Debug, _3: Debug, _4: Debug, _5: Debug, _6: Debug, _7: Debug, _8: Debug, _9: Debug, _10: Debug, _11: Debug> Debug for Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

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

Formats the value using the given formatter.

impl<const LEN: usize, _0: Default, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11> Default for Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

fn default() -> Self

Returns the “default value” for a type.

impl<const LEN: usize, _0: Hash, _1: Hash, _2: Hash, _3: Hash, _4: Hash, _5: Hash, _6: Hash, _7: Hash, _8: Hash, _9: Hash, _10: Hash, _11: Hash> Hash for Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

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<const LEN: usize, _0: PartialEq, _1: PartialEq, _2: PartialEq, _3: PartialEq, _4: PartialEq, _5: PartialEq, _6: PartialEq, _7: PartialEq, _8: PartialEq, _9: PartialEq, _10: PartialEq, _11: PartialEq> PartialEq for Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

fn eq( &self, other: &Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>, ) -> 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<const LEN: usize, _0: Copy, _1: Copy, _2: Copy, _3: Copy, _4: Copy, _5: Copy, _6: Copy, _7: Copy, _8: Copy, _9: Copy, _10: Copy, _11: Copy> Copy for Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

impl<const LEN: usize, _0: Eq, _1: Eq, _2: Eq, _3: Eq, _4: Eq, _5: Eq, _6: Eq, _7: Eq, _8: Eq, _9: Eq, _10: Eq, _11: Eq> Eq for Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>

impl<const LEN: usize, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11> StructuralPartialEq for Oneof<LEN, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11>