Struct controlled_option::ControlledOption

#[repr(transparent)]
pub struct ControlledOption<T> where
    T: Niche,  { /* fields omitted */ }

An Option type where you have control over the in-memory representation of the None and Some variants. See the module-level documentation for more information.

Implementations

impl<T> ControlledOption<T> where
    T: Niche, 

pub fn none() -> ControlledOption<T>

Creates a new None instance for this option.

pub fn some(value: T) -> ControlledOption<T>

Creates a new Some instance for this option.

pub fn is_none(&self) -> bool

Returns true is the option is a None value.

pub fn is_some(&self) -> bool

Returns true is the option is a Some value.

pub fn from_option(value: Option<T>) -> ControlledOption<T>

Transforms an Option into a ControlledOption.

pub fn into_option(self) -> Option<T>

Transforms a ControlledOption into an Option. This gives you access to all of the usual assortment of useful methods that you expect from an Option.

Trait Implementations

impl<T> Clone for ControlledOption<T> where
    T: Niche,
    T::Output: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ControlledOption<T> where
    T: Debug + Niche,
    T::Output: Clone, 

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

Formats the value using the given formatter.

impl<T> Default for ControlledOption<T> where
    T: Niche, 

fn default() -> ControlledOption<T>

Returns the “default value” for a type.

impl<T> From<Option<T>> for ControlledOption<T> where
    T: Niche, 

fn from(value: Option<T>) -> ControlledOption<T>

Performs the conversion.

impl<T> From<T> for ControlledOption<T> where
    T: Niche, 

fn from(value: T) -> ControlledOption<T>

Performs the conversion.

impl<T> Hash for ControlledOption<T> where
    T: Niche,
    T::Output: Hash, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T> Into<Option<T>> for ControlledOption<T> where
    T: Niche, 

fn into(self) -> Option<T>

Performs the conversion.

impl<T> Ord for ControlledOption<T> where
    T: Niche,
    T::Output: Ord, 

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T> PartialEq<ControlledOption<T>> for ControlledOption<T> where
    T: Niche,
    T::Output: PartialEq, 

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T> PartialOrd<ControlledOption<T>> for ControlledOption<T> where
    T: Niche,
    T::Output: PartialOrd, 

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Self) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Self) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Self) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Self) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Copy for ControlledOption<T> where
    T: Niche,
    T::Output: Copy, 

impl<T> Eq for ControlledOption<T> where
    T: Niche,
    T::Output: Eq,