Struct idcontain::OptionId

pub struct OptionId<T>(_);

An Option-like container of Id<T> that takes up no additional space.

Internally, None is represented as Id::invalid(). An OptionId<T> implements conversion to and from an Option<Id<T>>, but it also forwards all the methods that Option<T> does, for convenience.

Methods

impl<T> OptionId<T>

pub fn some(id: Id<T>) -> Self

pub fn none() -> Self

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

pub fn is_none(&self) -> bool

pub fn is_some(&self) -> bool

pub fn as_ref(&self) -> Option<&Id<T>>

pub fn as_mut(&mut self) -> Option<&mut Id<T>>

pub fn expect(self, msg: &str) -> Id<T>

pub fn unwrap(self) -> Id<T>

pub fn unwrap_or(self, def: Id<T>) -> Id<T>

pub fn unwrap_or_else<F>(self, f: F) -> Id<T> where
    F: FnOnce() -> Id<T>, 

pub fn map<U, F>(self, f: F) -> Option<U> where
    F: FnOnce(Id<T>) -> U, 

pub fn map_or<U, F>(self, default: U, f: F) -> U where
    F: FnOnce(Id<T>) -> U, 

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U where
    D: FnOnce() -> U,
    F: FnOnce(Id<T>) -> U, 

pub fn ok_or<E>(self, err: E) -> Result<Id<T>, E>

pub fn ok_or_else<E, F>(self, err: F) -> Result<Id<T>, E> where
    F: FnOnce() -> E, 

pub fn iter(&self) -> OptionIntoIter<&Id<T>>

pub fn iter_mut(&mut self) -> OptionIntoIter<&mut Id<T>>

pub fn and<U, O>(self, optb: O) -> Option<U> where
    O: Into<Option<U>>, 

pub fn and_then<U, O, F>(self, f: F) -> Option<U> where
    F: FnOnce(Id<T>) -> O,
    O: Into<Option<U>>, 

pub fn or<O>(self, optb: O) -> Option<Id<T>> where
    O: Into<Option<Id<T>>>, 

pub fn or_else<F, O>(self, f: F) -> Option<Id<T>> where
    F: FnOnce() -> O,
    O: Into<Option<Id<T>>>, 

pub fn take(&mut self) -> Self

Trait Implementations

impl<T> Into<Option<Id<T>>> for OptionId<T>

fn into(self) -> Option<Id<T>>

Performs the conversion.

impl<T> From<Option<Id<T>>> for OptionId<T>

fn from(option: Option<Id<T>>) -> Self

Performs the conversion.

impl<T> Clone for OptionId<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Copy for OptionId<T>

impl<T> Default for OptionId<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T> Eq for OptionId<T>

impl<T> Ord for OptionId<T>

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T> PartialEq<OptionId<T>> for OptionId<T>

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> PartialOrd<OptionId<T>> for OptionId<T>

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl<T> Debug for OptionId<T>

fn fmt(&self, formatter: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl<T> Hash for OptionId<T>

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, 

Feeds a slice of this type into the given [Hasher].