Struct yoke::cartable_ptr::CartableOptionPointer

pub struct CartableOptionPointer<C>
where
    C: CartablePointerLike,
{
    inner: NonNull<C::Raw>,
    _cartable: PhantomData<C>,
}

A type with similar semantics as Option<C<T>> but with a niche.

This type cannot be publicly constructed. To use this in a Yoke, see Yoke::convert_cart_into_option_pointer.

Fields

inner: NonNull<C::Raw>

The inner pointer.

Invariants

1. Must be either SENTINEL_PTR or created from CartablePointerLike::into_raw
2. If non-sentinel, must always be for a valid SelectedRc

_cartable: PhantomData<C>

Implementations

impl<C> CartableOptionPointer<C>

where C: CartablePointerLike,

pub(crate) fn none() -> Self

Creates a new instance corresponding to a None value.

pub(crate) fn from_cartable(cartable: C) -> Self

Creates a new instance corresponding to a Some value.

pub fn is_none(&self) -> bool

Returns whether this instance is None. From the return value:

• If true, the instance is None
• If false, the instance is a valid SelectedRc

Trait Implementations

impl<C> Clone for CartableOptionPointer<C>

where C: CloneableCartablePointerLike,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for CartableOptionPointer<C>

where C: CartablePointerLike + Debug, C::Raw: Debug,

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

Formats the value using the given formatter.

impl<C> Drop for CartableOptionPointer<C>

where C: CartablePointerLike,

fn drop(&mut self)

Executes the destructor for this type.

impl<C> CloneableCart for CartableOptionPointer<C>

where C: CloneableCartablePointerLike + CloneableCart,

impl<C> Send for CartableOptionPointer<C>

where C: Sync + CartablePointerLike,

impl<C> Sync for CartableOptionPointer<C>

where C: Send + CartablePointerLike,