Enum ArchivedResult

#[repr(u8)]
pub enum ArchivedResult<T, E> {
    Ok(T),
    Err(E),
}

Available on crate feature dep_rkyv only.

An archived Result that represents either success (Ok) or failure (Err).

Variants

Ok(T)

Contains the success value

Err(E)

Contains the error value

Implementations

impl<T, E> ArchivedResult<T, E>

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

Converts from ArchivedResult<T, E> to Option<T>.

pub fn unwrap(self) -> T

Returns the contained Ok value, consuming the self value.

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

where F: FnOnce(E) -> T,

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

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

pub fn as_ref(&self) -> Result<&T, &E>

Returns a Result containing the success and error values of this ArchivedResult.

pub fn as_mut(&mut self) -> Result<&mut T, &mut E>

Converts from &mut ArchivedResult<T, E> to Result<&mut T, &mut E>.

pub fn as_seal( this: Seal<'_, ArchivedResult<T, E>>, ) -> Result<Seal<'_, T>, Seal<'_, E>>

Converts from Seal<'_, ArchivedResult<T, E>> to Result<Seal<'_, T>, Seal<'_, E>>.

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

Returns an iterator over the possibly-contained value.

The iterator yields one value if the result is ArchivedResult::Ok, otherwise none.

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

Returns an iterator over the mutable possibly-contained value.

The iterator yields one value if the result is ArchivedResult::Ok, otherwise none.

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

Returns an iterator over the sealed possibly-contained value.

The iterator yields one value if the result is ArchivedResult::Ok, otherwise none.

impl<T, E> ArchivedResult<T, E>

where T: Deref,

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>

Converts from &ArchivedResult<T, E> to Result<&<T as Deref>::Target, &E>.

Coerces the Ok variant of the original ArchivedResult via Deref and returns the new Result.

impl<T, E> ArchivedResult<T, E>

where T: DerefMut,

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

Converts from &mut ArchivedResult<T, E> to Result<&mut <T as Deref>::Target, &mut E>.

Coerces the Ok variant of the original ArchivedResult via DerefMut and returns the new Result.

Trait Implementations

impl<T, E, __C> CheckBytes<__C> for ArchivedResult<T, E>

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

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

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

impl<T, E> Debug for ArchivedResult<T, E>

where T: Debug, E: Debug,

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

Formats the value using the given formatter.

impl<T, U, D> Deserialize<Result<T, U>, D> for ArchivedResult<<T as Archive>::Archived, <U as Archive>::Archived>

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

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

Deserializes using the given deserializer

impl<T, E> Hash for ArchivedResult<T, E>

where T: Hash, E: 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<T, E> Ord for ArchivedResult<T, E>

where T: Ord, E: Ord,

fn cmp(&self, other: &ArchivedResult<T, E>) -> 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, E, F> PartialEq<Result<T, E>> for ArchivedResult<U, F>

where U: PartialEq<T>, F: PartialEq<E>,

fn eq(&self, other: &Result<T, E>) -> 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, E> PartialEq for ArchivedResult<T, E>

where T: PartialEq, E: PartialEq,

fn eq(&self, other: &ArchivedResult<T, E>) -> 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, E> PartialOrd for ArchivedResult<T, E>

where T: PartialOrd, E: PartialOrd,

fn partial_cmp(&self, other: &ArchivedResult<T, E>) -> 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, E> Eq for ArchivedResult<T, E>

where T: Eq, E: Eq,

impl<T, E> Portable for ArchivedResult<T, E>

where T: Portable, E: Portable,