Enum COption 

#[repr(u8)]
pub enum COption<TValue>
where
    TValue: ReprC,
{
    None = 0,
    Some(TValue),
}

This enum is essentially the same as the standard Option, except it is #[repr(C)] and thus safe to use a across the ffi boundaries.

It additionally provides const variants of Option methods.

Variants

None = 0

Some(TValue)

Implementations

impl<TValue> COption<TValue>

where TValue: ReprC,

pub const fn is_some(&self) -> bool

Returns true if the enum holds COption::Some, false otherwise.

pub const fn is_none(&self) -> bool

Returns true if the enum holds COption::None, false otherwise.

pub fn expect(self, message: &str) -> TValue

Unwraps currently stored COption::Some value.

Panics

Only when self actually holds a COption::None value.

pub const fn unwrap(self) -> TValue

Unwraps currently stored COption::Some value.

Panics

Only when self actually holds a COption::None value.

pub const unsafe fn unwrap_unchecked(self) -> TValue

Unwraps currently stored COption::Some value.

Safety

This function does not verify whether the stored value is actually COption::Some. The behaviour is undefined if it is not.

pub const fn into_option(self) -> Option<TValue>

Converts COption into standard Option.

pub const fn from_option(option: Option<TValue>) -> Self

Converts standard Option into COption.

pub const fn as_ref(&self) -> COption<&TValue>

Converts COption into a reference to the stored value.

pub const fn as_mut(&mut self) -> COption<&mut TValue>

Converts COption into a mutable reference to the stored value.

Trait Implementations

impl<TValue: ReprC + Clone> Clone for COption<TValue>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<TValue> Debug for COption<TValue>

where TValue: ReprC + Debug,

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

Formats the value using the given formatter.

impl<TValue: ReprC> Default for COption<TValue>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, TValue: ReprC + Deserialize<'de>> Deserialize<'de> for COption<TValue>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TValue: ReprC + Display> Display for COption<TValue>

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

Formats the value using the given formatter.

impl<TValue: ReprC + Eq> Eq for COption<TValue>

impl<TValue: ReprC> From<COption<TValue>> for Option<TValue>

fn from(option: COption<TValue>) -> Self

Converts to this type from the input type.

impl<TValue: ReprC> From<Option<TValue>> for COption<TValue>

fn from(option: Option<TValue>) -> Self

Converts to this type from the input type.

impl<TValue: ReprC + Hash> Hash for COption<TValue>

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<TValue: ReprC + PartialEq> PartialEq for COption<TValue>

fn eq(&self, other: &Self) -> 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<TValue> ReprC for COption<TValue>

where TValue: ReprC,

const CHECK: ()

This field is used for const checks only.

impl<TValue: ReprC + Serialize> Serialize for COption<TValue>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<TValue: ReprC + TryClone> TryClone for COption<TValue>

type Error = <TValue as TryClone>::Error

fn try_clone(&self) -> Result<Self, Self::Error>

Tries to clone the type.