Enum rkyv::result::ArchivedResult

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

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 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) -> IterMut<'_, T>

Returns a mutable iterator over the possibly contained value.

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

impl<T: Deref, E> ArchivedResult<T, E>

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: DerefMut, E> ArchivedResult<T, E>

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<__C: ?Sized, T, E> CheckBytes<__C> for ArchivedResult<T, E>

where T: CheckBytes<__C>, E: CheckBytes<__C>,

type Error = EnumCheckError<u8>

The error that may result from checking the type.

unsafe fn check_bytes<'__bytecheck>( value: *const Self, context: &mut __C, ) -> Result<&'__bytecheck Self, EnumCheckError<u8>>

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

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

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

Formats the value using the given formatter.

impl<T, E, D> Deserialize<Result<T, E>, D> for ArchivedResult<T::Archived, E::Archived>

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

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

Deserializes using the given deserializer

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

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

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: PartialEq<U>, U, E: PartialEq<F>, F> PartialEq<ArchivedResult<T, E>> for Result<U, F>

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, U: PartialEq<T>, E, F: PartialEq<E>> PartialEq<Result<T, E>> for ArchivedResult<U, F>

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: PartialEq, E: PartialEq> PartialEq for ArchivedResult<T, E>

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

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

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: Eq, E: Eq> Eq for ArchivedResult<T, E>