Struct interoptopus::patterns::option::FFIOption

#[repr(C)]
pub struct FFIOption<T> { /* fields omitted */ }

An option-like type at the FFI boundary where a regular Option doesn’t work.

C API

The option will be considered Some if and only if is_some is 1. All other values mean None.

Implementations

impl<T> FFIOption<T>

pub const fn some(data: T) -> Self

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

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

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

pub fn is_some(&self) -> bool

pub fn is_none(&self) -> bool

pub fn unwrap(self) -> T

Get the value or panic.

Panics

Panics if the value is None.

pub fn unwrap_as_mut(&mut self) -> &mut T

Get the value as a mutable reference or panic.

Panics

Panics if the value is None.

impl<T: Default> FFIOption<T>

pub fn none() -> Self

Trait Implementations

impl<T> CTypeInfo for FFIOption<T> where
    T: CTypeInfo, 

fn type_info() -> CType

impl<T: Clone> Clone for FFIOption<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for FFIOption<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for FFIOption<T>

fn default() -> FFIOption<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for FFIOption<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: Default> From<Option<T>> for FFIOption<T>

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

Performs the conversion.

impl<T: PartialEq> PartialEq<FFIOption<T>> for FFIOption<T>

fn eq(&self, other: &FFIOption<T>) -> bool

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

fn ne(&self, other: &FFIOption<T>) -> bool

This method tests for !=.

impl<T> Serialize for FFIOption<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for FFIOption<T>

impl<T> StructuralPartialEq for FFIOption<T>