Struct NichedOption

#[repr(transparent)]
pub struct NichedOption<U, const N: usize>(pub Option<U>);

Optional type which uses NichedOptionULE<U,N> as ULE type.

The implementors guarantee that N == core::mem::size_of::<Self>() [repr(transparent)] guarantees that the layout is same as Option<U>

Tuple Fields

0: Option<U>

Trait Implementations

impl<U: AsULE, const N: usize> AsULE for NichedOption<U, N>

where U::ULE: NicheBytes<N>,

type ULE = NichedOptionULE<<U as AsULE>::ULE, N>

The ULE type corresponding to Self.

fn to_unaligned(self) -> Self::ULE

Converts from Self to Self::ULE.

fn from_unaligned(unaligned: Self::ULE) -> Self

Converts from Self::ULE to Self.

impl<U: Clone, const N: usize> Clone for NichedOption<U, N>

fn clone(&self) -> NichedOption<U, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<U: Debug, const N: usize> Debug for NichedOption<U, N>

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

Formats the value using the given formatter.

impl<U, const N: usize> Default for NichedOption<U, N>

fn default() -> Self

Returns the “default value” for a type.

impl<U: Hash, const N: usize> Hash for NichedOption<U, N>

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, const N: usize> IntoIterator for NichedOption<T, N>

type IntoIter = <Option<T> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<U: Ord, const N: usize> Ord for NichedOption<U, N>

fn cmp(&self, other: &NichedOption<U, N>) -> 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<U: PartialEq, const N: usize> PartialEq for NichedOption<U, N>

fn eq(&self, other: &NichedOption<U, N>) -> 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<U: PartialOrd, const N: usize> PartialOrd for NichedOption<U, N>

fn partial_cmp(&self, other: &NichedOption<U, N>) -> 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<'a, T: AsULE + 'static, const N: usize> ZeroMapKV<'a> for NichedOption<T, N>

where T::ULE: NicheBytes<N>,

type Container = ZeroVec<'a, NichedOption<T, N>>

The container that can be used with this type: ZeroVec or VarZeroVec.

type Slice = ZeroSlice<NichedOption<T, N>>

type GetType = <NichedOption<T, N> as AsULE>::ULE

The type produced by Container::get()

type OwnedType = NichedOption<T, N>

The type produced by Container::replace() and Container::remove(), also used during deserialization. If Self is human readable serialized, deserializing to Self::OwnedType should produce the same value once passed through Self::owned_as_self()

impl<U: Copy, const N: usize> Copy for NichedOption<U, N>

impl<U: Eq, const N: usize> Eq for NichedOption<U, N>

impl<U, const N: usize> StructuralPartialEq for NichedOption<U, N>