Struct NichedOption

#[non_exhaustive]
#[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::sizeo_of::<Self>() [repr(transparent)] guarantees that the layout is same as Option<U>

Tuple Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

0: Option<U>

Implementations

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

pub const fn new(o: Option<U>) -> Self

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 copy 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, const N: usize> From<Option<U>> for NichedOption<U, N>

fn from(o: Option<U>) -> Self

Converts to this type from the input 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<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: 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>