Enum Optional

#[repr(C)]
pub enum Optional<T> {
    Some(T),
    None,
}

FFI-safe variant of Option.

Implements the From and Into traits for easy conversion to and from Option.

Variants

Some(T)

Some value T

None

No value

Implementations

impl<T> Optional<T>

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

Converts the Optional to an Option.

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

Converts from &Optional<T> to Option<&T>.

For convenience, this method directly performs the conversion to the standard Option type.

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

Converts from &mut Optional<T> to Option<&mut T>.

For convenience, this method directly performs the conversion to the standard Option type.

Trait Implementations

impl<T: Clone> Clone for Optional<T>

fn clone(&self) -> Optional<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Optional<T>

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

Formats the value using the given formatter.

impl<T> From<Option<T>> for Optional<T>

fn from(v: Option<T>) -> Self

Converts to this type from the input type.

impl<T> From<Optional<T>> for Option<T>

fn from(optional: Optional<T>) -> Option<T>

Converts to this type from the input type.

impl<T: Hash> Hash for Optional<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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Optional<T>

fn cmp(&self, other: &Optional<T>) -> 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<T: PartialEq> PartialEq for Optional<T>

fn eq(&self, other: &Optional<T>) -> 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<T: PartialOrd> PartialOrd for Optional<T>

fn partial_cmp(&self, other: &Optional<T>) -> 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<T: Copy> Copy for Optional<T>

impl<T: Eq> Eq for Optional<T>

impl<T> StructuralPartialEq for Optional<T>