Struct ConstEither 

pub struct ConstEither<L, R, const IS_RIGHT: bool>(/* private fields */);

An Either type that is known to hold a left or right value at compile-time. This allows data structures choose an appropriate type based on some compile-time determined policy.

Example

struct TheOneVec<T, const INLINE: bool, const MIN_CAPACITY: usize> {
    data: ConstEither<Vec<T>, tinyvec::ArrayVec<[T; MIN_CAPACITY]>, INLINE>,
}

impl<T, const MIN_CAPACITY: usize> TheOneVec<T, false, MIN_CAPACITY> {
    fn new() -> Self {
        TheOneVec { data: ConstEither::new(Vec::with_capacity(MIN_CAPACITY)) }
    }
}

impl<T, const MIN_CAPACITY: usize> TheOneVec<T, true, MIN_CAPACITY> {
    fn new() -> Self {
        TheOneVec { data: ConstEither::new(tinyvec::ArrayVec::new()) }
    }
}

struct TheOneString<const INLINE: bool>(TheOneVec<u8, INLINE, 32>);

struct MaybeHeaplessPerson<const INLINE: bool> {
    name: TheOneString<INLINE>,
    age: usize,
    hobbies: TheOneVec<TheOneString<INLINE>, INLINE, 16>,
}

Implementations

impl<L, R> ConstEither<L, R, false>

pub fn new(left: L) -> Self

pub fn into_inner(self) -> L

pub fn flip(self) -> ConstEither<R, L, true>

impl<L, R> ConstEither<L, R, true>

pub fn new(right: R) -> Self

pub fn into_inner(self) -> R

pub fn flip(self) -> ConstEither<R, L, false>

Trait Implementations

impl<L, R> AsMut<L> for ConstEither<L, R, false>

fn as_mut(&mut self) -> &mut L

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

impl<L, R> AsMut<R> for ConstEither<L, R, true>

fn as_mut(&mut self) -> &mut R

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

impl<L, R> AsRef<L> for ConstEither<L, R, false>

fn as_ref(&self) -> &L

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

impl<L, R> AsRef<R> for ConstEither<L, R, true>

fn as_ref(&self) -> &R

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

impl<L, R> Deref for ConstEither<L, R, false>

type Target = L

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<L, R> Deref for ConstEither<L, R, true>

type Target = R

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<L, R> DerefMut for ConstEither<L, R, false>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<L, R> DerefMut for ConstEither<L, R, true>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<L, R, const IS_RIGHT: bool> Drop for ConstEither<L, R, IS_RIGHT>

fn drop(&mut self)

Executes the destructor for this type.