Struct rkyv::niche::option_box::ArchivedOptionBox

pub struct ArchivedOptionBox<T: ArchivePointee + ?Sized> { /* private fields */ }

A niched archived Option<Box<T>>.

It uses less space by storing the None variant as a null pointer.

Implementations

impl<T: ArchivePointee + ?Sized> ArchivedOptionBox<T>

pub fn is_none(&self) -> bool

Returns true if the option box is a None value.

pub fn is_some(&self) -> bool

Returns true if the option box is a Some value.

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

Converts to an Option<&ArchivedBox<T>>.

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

Converts to an Option<&mut ArchivedBox<T>>.

pub fn as_pin_ref(self: Pin<&Self>) -> Option<Pin<&ArchivedBox<T>>>

Converts from Pin<&ArchivedOptionBox<T>> to Option<Pin<&ArchivedBox<T>>>.

pub fn as_pin_mut(self: Pin<&mut Self>) -> Option<Pin<&mut ArchivedBox<T>>>

Converts from Pin<&mut ArchivedOption<T>> to Option<Pin<&mut ArchivedBox<T>>>.

pub fn iter(&self) -> Iter<'_, ArchivedBox<T>>

Returns an iterator over the possibly contained value.

pub fn iter_mut(&mut self) -> IterMut<'_, ArchivedBox<T>>

Returns a mutable iterator over the possibly contained value.

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

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

Leaves the original ArchivedOptionBox in-place, creating a new one with a reference to the original one.

impl<T: ArchivePointee + ?Sized> ArchivedOptionBox<T>

where T::ArchivedMetadata: Default,

pub unsafe fn resolve_from_option<U: ArchiveUnsized<Archived = T> + ?Sized>( field: Option<&U>, pos: usize, resolver: OptionBoxResolver<U::MetadataResolver>, out: *mut Self, )

Resolves an ArchivedOptionBox<T::Archived> from an Option<&T>.

Safety

• pos must be the position of out within the archive
• resolver must be the result of serializing field

pub fn serialize_from_option<U, S>( field: Option<&U>, serializer: &mut S, ) -> Result<OptionBoxResolver<U::MetadataResolver>, S::Error>

where U: SerializeUnsized<S, Archived = T> + ?Sized, S: Serializer + ?Sized,

Serializes an ArchivedOptionBox<T::Archived> from an Option<&T>.

Trait Implementations

impl<T: ArchivePointee + ?Sized> Debug for ArchivedOptionBox<T>

where T::ArchivedMetadata: Debug,

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

Formats the value using the given formatter.

impl<T, D> DeserializeWith<ArchivedOptionBox<<T as ArchiveUnsized>::Archived>, Option<Box<T>>, D> for Niche

where T: ArchiveUnsized + ?Sized, T::Archived: DeserializeUnsized<T, D>, D: Fallible + ?Sized,

fn deserialize_with( field: &ArchivedOptionBox<T::Archived>, deserializer: &mut D, ) -> Result<Option<Box<T>>, D::Error>

Deserializes the field type F using the given deserializer.

impl<T: ArchivePointee + Hash + ?Sized> Hash for ArchivedOptionBox<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: ArchivePointee + Ord + ?Sized> Ord for ArchivedOptionBox<T>

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<T, U> PartialEq<ArchivedOptionBox<T>> for Option<Box<U>>

where T: ArchivePointee + PartialEq<U> + ?Sized, U: ?Sized,

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, U> PartialEq<Option<Box<T>>> for ArchivedOptionBox<U>

where T: ?Sized, U: ArchivePointee + PartialEq<T> + ?Sized,

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ArchivePointee + PartialEq + ?Sized> PartialEq for ArchivedOptionBox<T>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ArchivePointee + PartialOrd + ?Sized> PartialOrd for ArchivedOptionBox<T>

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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: ArchivePointee + Eq + ?Sized> Eq for ArchivedOptionBox<T>