Enum rocket::outcome::Outcome

#[must_use]
pub enum Outcome<S, E, F> {
    Success(S),
    Failure(E),
    Forward(F),
}

An enum representing success (Success), failure (Failure), or forwarding (Forward).

See the top level documentation for detailed information.

Variants

Success(S)

Contains the success value.

Failure(E)

Contains the failure error value.

Forward(F)

Contains the value to forward on.

Methods

impl<S, E, F> Outcome<S, E, F>

fn unwrap(self) -> S

Unwraps the Outcome, yielding the contents of a Success.

Panics

Panics if the value is not Success.

Examples

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.unwrap(), 10);

fn expect(self, message: &str) -> S

Unwraps the Outcome, yielding the contents of a Success.

Panics

If the value is not Success, panics with the given message.

Examples

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.expect("success value"), 10);

fn is_success(&self) -> bool

Return true if this Outcome is a Success.

Examples

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.is_success(), true);

let x: Outcome<i32, &str, usize> = Failure("Hi! I'm an error.");
assert_eq!(x.is_success(), false);

let x: Outcome<i32, &str, usize> = Forward(25);
assert_eq!(x.is_success(), false);

fn is_failure(&self) -> bool

Return true if this Outcome is a Failure.

Examples

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.is_failure(), false);

let x: Outcome<i32, &str, usize> = Failure("Hi! I'm an error.");
assert_eq!(x.is_failure(), true);

let x: Outcome<i32, &str, usize> = Forward(25);
assert_eq!(x.is_failure(), false);

fn is_forward(&self) -> bool

Return true if this Outcome is a Forward.

Examples

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.is_forward(), false);

let x: Outcome<i32, &str, usize> = Failure("Hi! I'm an error.");
assert_eq!(x.is_forward(), false);

let x: Outcome<i32, &str, usize> = Forward(25);
assert_eq!(x.is_forward(), true);

fn succeeded(self) -> Option<S>

Converts from Outcome<S, E, F> to Option<S>.

Returns the Some of the Success if this is a Success, otherwise returns None. self is consumed, and all other values are discarded.

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.succeeded(), Some(10));

let x: Outcome<i32, &str, usize> = Failure("Hi! I'm an error.");
assert_eq!(x.succeeded(), None);

let x: Outcome<i32, &str, usize> = Forward(25);
assert_eq!(x.succeeded(), None);

fn failed(self) -> Option<E>

Converts from Outcome<S, E, F> to Option<E>.

Returns the Some of the Failure if this is a Failure, otherwise returns None. self is consumed, and all other values are discarded.

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.failed(), None);

let x: Outcome<i32, &str, usize> = Failure("Hi! I'm an error.");
assert_eq!(x.failed(), Some("Hi! I'm an error."));

let x: Outcome<i32, &str, usize> = Forward(25);
assert_eq!(x.failed(), None);

fn forwarded(self) -> Option<F>

Converts from Outcome<S, E, F> to Option<F>.

Returns the Some of the Forward if this is a Forward, otherwise returns None. self is consumed, and all other values are discarded.

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.forwarded(), None);

let x: Outcome<i32, &str, usize> = Failure("Hi! I'm an error.");
assert_eq!(x.forwarded(), None);

let x: Outcome<i32, &str, usize> = Forward(25);
assert_eq!(x.forwarded(), Some(25));

fn as_ref(&self) -> Outcome<&S, &E, &F>

Converts from Outcome<S, E, F> to Outcome<&S, &E, &F>.

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.as_ref(), Success(&10));

let x: Outcome<i32, &str, usize> = Failure("Hi! I'm an error.");
assert_eq!(x.as_ref(), Failure(&"Hi! I'm an error."));

fn as_mut(&mut self) -> Outcome<&mut S, &mut E, &mut F>

Converts from Outcome<S, E, F> to Outcome<&mut S, &mut E, &mut F>.

let mut x: Outcome<i32, &str, usize> = Success(10);
if let Success(val) = x.as_mut() {
    *val = 20;
}

assert_eq!(x.unwrap(), 20);

Trait Implementations

impl<S: Clone, E: Clone, F: Clone> Clone for Outcome<S, E, F>

fn clone(&self) -> Outcome<S, E, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Copy, E: Copy, F: Copy> Copy for Outcome<S, E, F>

impl<S: PartialEq, E: PartialEq, F: PartialEq> PartialEq for Outcome<S, E, F>

fn eq(&self, __arg_0: &Outcome<S, E, F>) -> bool

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

fn ne(&self, __arg_0: &Outcome<S, E, F>) -> bool

This method tests for !=.

impl<S: PartialOrd, E: PartialOrd, F: PartialOrd> PartialOrd for Outcome<S, E, F>

fn partial_cmp(&self, __arg_0: &Outcome<S, E, F>) -> Option<Ordering>

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

fn lt(&self, __arg_0: &Outcome<S, E, F>) -> bool

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

fn le(&self, __arg_0: &Outcome<S, E, F>) -> bool

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

fn gt(&self, __arg_0: &Outcome<S, E, F>) -> bool

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

fn ge(&self, __arg_0: &Outcome<S, E, F>) -> bool

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

impl<S: Eq, E: Eq, F: Eq> Eq for Outcome<S, E, F>

impl<S: Ord, E: Ord, F: Ord> Ord for Outcome<S, E, F>

fn cmp(&self, __arg_0: &Outcome<S, E, F>) -> Ordering

This method returns an Ordering between self and other.

impl<S: Hash, E: Hash, F: Hash> Hash for Outcome<S, E, F>

fn hash<__HSEF: Hasher>(&self, __arg_0: &mut __HSEF)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<S, E, F> Debug for Outcome<S, E, F>

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

Formats the value using the given formatter.

impl<S, E, F> Display for Outcome<S, E, F>

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

Formats the value using the given formatter.