Enum ArchivedOption

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

Available on crate feature dep_rkyv only.

An archived Option.

It functions identically to Option but has a different internal representation to allow for archiving.

Variants

None

No value

Some(T)

Some value T

Implementations

impl<T> ArchivedOption<T>

pub fn ok_or<E>(self, err: E) -> Result<T, E>

Transforms the ArchivedOption<T> into a Result<T, E>, mapping Some(v) to Ok(v) and None to Err(err).

pub fn unwrap(self) -> T

Returns the contained Some value, consuming the self value.

pub fn unwrap_or(self, default: T) -> T

Returns the contained Some value or a provided default.

pub fn unwrap_or_else<F>(self, f: F) -> T

where F: FnOnce() -> T,

Returns the contained Some value or computes it from a closure.

pub fn is_none(&self) -> bool

Returns true if the option is a None value.

pub fn is_some(&self) -> bool

Returns true if the option is a Some value.

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

Converts to an Option<&T>.

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

Converts to an Option<&mut T>.

pub fn as_seal(this: Seal<'_, ArchivedOption<T>>) -> Option<Seal<'_, T>>

Converts from Seal<'_, ArchivedOption<T>> to Option<Seal<'_, T>>.

pub const fn iter(&self) -> Iter<&T>

Returns an iterator over the possibly-contained value.

pub fn iter_mut(&mut self) -> Iter<&mut T>

Returns an iterator over the mutable possibly-contained value.

pub fn iter_seal(this: Seal<'_, ArchivedOption<T>>) -> Iter<Seal<'_, T>>

Returns an iterator over the sealed possibly-contained value.

pub fn get_or_insert(&mut self, v: T) -> &mut T

Inserts v into the option if it is None, then returns a mutable reference to the contained value.

pub fn get_or_insert_with<F>(&mut self, f: F) -> &mut T

where F: FnOnce() -> T,

Inserts a value computed from f into the option if it is None, then returns a mutable reference to the contained value.

impl<T> ArchivedOption<T>

where T: Deref,

pub fn as_deref(&self) -> Option<&<T as Deref>::Target>

Converts from &ArchivedOption<T> to Option<&T::Target>.

Leaves the original ArchivedOption in-place, creating a new one with a reference to the original one, additionally coercing the contents via Deref.

impl<T> ArchivedOption<T>

where T: DerefMut,

pub fn as_deref_mut(&mut self) -> Option<&mut <T as Deref>::Target>

Converts from &mut ArchivedOption<T> to Option<&mut T::Target>.

Leaves the original ArchivedOption in-place, creating a new Option with a mutable reference to the inner type’s Deref::Target type.

Trait Implementations

impl<T, __C> CheckBytes<__C> for ArchivedOption<T>

where __C: Fallible + ?Sized, <__C as Fallible>::Error: Source, T: CheckBytes<__C>,

unsafe fn check_bytes( value: *const ArchivedOption<T>, context: &mut __C, ) -> Result<(), <__C as Fallible>::Error>

Checks whether the given pointer points to a valid value within the given context.

impl<T> Clone for ArchivedOption<T>

where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ArchivedOption<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T, D> Deserialize<Option<T>, D> for ArchivedOption<<T as Archive>::Archived>

where T: Archive, <T as Archive>::Archived: Deserialize<T, D>, D: Fallible + ?Sized,

fn deserialize( &self, deserializer: &mut D, ) -> Result<Option<T>, <D as Fallible>::Error>

Deserializes using the given deserializer

impl<A, O, D> DeserializeWith<ArchivedOption<<A as ArchiveWith<O>>::Archived>, Option<O>, D> for Map<A>

where D: Fallible + ?Sized, A: ArchiveWith<O> + DeserializeWith<<A as ArchiveWith<O>>::Archived, O, D>,

fn deserialize_with( field: &ArchivedOption<<A as ArchiveWith<O>>::Archived>, d: &mut D, ) -> Result<Option<O>, <D as Fallible>::Error>

Deserializes the field type F using the given deserializer.

impl<T> From<T> for ArchivedOption<T>

fn from(val: T) -> ArchivedOption<T>

Moves val into a new Some.

Examples

let o: ArchivedOption<u8> = ArchivedOption::from(67);

assert!(matches!(o, ArchivedOption::Some(67)));

impl<T> Hash for ArchivedOption<T>

where T: Hash,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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<'a, T> IntoIterator for &'a ArchivedOption<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<&'a T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a ArchivedOption<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut ArchivedOption<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = Iter<&'a mut T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut ArchivedOption<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> Ord for ArchivedOption<T>

where T: Ord,

fn cmp(&self, other: &ArchivedOption<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, U> PartialEq<Option<T>> for ArchivedOption<U>

where U: PartialEq<T>,

fn eq(&self, other: &Option<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> PartialEq for ArchivedOption<T>

where T: PartialEq,

fn eq(&self, other: &ArchivedOption<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, U> PartialOrd<Option<T>> for ArchivedOption<U>

where U: PartialOrd<T>,

fn partial_cmp(&self, other: &Option<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> PartialOrd for ArchivedOption<T>

where T: PartialOrd,

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

where T: Copy,

impl<T> Eq for ArchivedOption<T>

where T: Eq,

impl<T> Portable for ArchivedOption<T>

where T: Portable,