Enum rocket::outcome::Outcome[][src]

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

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.

Implementations

impl<S, E, F> Outcome<S, E, F>[src]

pub fn unwrap(self) -> S[src]

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);

pub fn expect(self, message: &str) -> S[src]

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);

pub fn is_success(&self) -> bool[src]

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);

pub fn is_failure(&self) -> bool[src]

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);

pub fn is_forward(&self) -> bool[src]

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);

pub fn succeeded(self) -> Option<S>[src]

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);

pub fn failed(self) -> Option<E>[src]

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);

pub fn forwarded(self) -> Option<F>[src]

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));

pub fn success_or<T>(self, value: T) -> Result<S, T>[src]

Returns a Success value as Ok() or value in Err. Converts from Outcome<S, E, F> to Result<S, T> for a given T.

Returns Ok with the Success value if this is a Success, otherwise returns an Err with the provided value. self is consumed, and all other values are discarded.

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

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

let x: Outcome<i32, &str, usize> = Forward(25);
assert_eq!(x.success_or("whoops"), Err("whoops"));

pub fn success_or_else<T, V: FnOnce() -> T>(self, f: V) -> Result<S, T>[src]

Returns a Success value as Ok() or f() in Err. Converts from Outcome<S, E, F> to Result<S, T> for a given T produced from a supplied function or closure.

Returns Ok with the Success value if this is a Success, otherwise returns an Err with the result of calling f. self is consumed, and all other values are discarded.

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

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

let x: Outcome<i32, &str, usize> = Forward(25);
assert_eq!(x.success_or_else(|| "whoops"), Err("whoops"));

pub fn as_ref(&self) -> Outcome<&S, &E, &F>[src]

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."));

pub fn as_mut(&mut self) -> Outcome<&mut S, &mut E, &mut F>[src]

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);

pub fn map<T, M: FnOnce(S) -> T>(self, f: M) -> Outcome<T, E, F>[src]

Maps the Success value using f. Maps an Outcome<S, E, F> to an Outcome<T, E, F> by applying the function f to the value of type S in self if self is an Outcome::Success.

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

let mapped = x.map(|v| if v == 10 { "10" } else { "not 10" });
assert_eq!(mapped, Success("10"));

pub fn map_failure<T, M: FnOnce(E) -> T>(self, f: M) -> Outcome<S, T, F>[src]

Maps the Failure value using f. Maps an Outcome<S, E, F> to an Outcome<S, T, F> by applying the function f to the value of type E in self if self is an Outcome::Failure.

let x: Outcome<i32, &str, usize> = Failure("hi");

let mapped = x.map_failure(|v| if v == "hi" { 10 } else { 0 });
assert_eq!(mapped, Failure(10));

pub fn map_forward<T, M: FnOnce(F) -> T>(self, f: M) -> Outcome<S, E, T>[src]

Maps the Forward value using f. Maps an Outcome<S, E, F> to an Outcome<S, E, T> by applying the function f to the value of type F in self if self is an Outcome::Forward.

let x: Outcome<i32, &str, usize> = Forward(5);

let mapped = x.map_forward(|v| if v == 5 { "a" } else { "b" });
assert_eq!(mapped, Forward("a"));

pub fn and_then<T, M: FnOnce(S) -> Outcome<T, E, F>>(
    self,
    f: M
) -> Outcome<T, E, F>
[src]

Converts from Outcome<S, E, F> to Outcome<T, E, F> using f to map Success(S) to Success(T).

If self is not Success, self is returned.

Examples

let x: Outcome<i32, &str, bool> = Success(10);

let mapped = x.and_then(|v| match v {
   10 => Success("10"),
   1 => Forward(false),
   _ => Failure("30")
});

assert_eq!(mapped, Success("10"));

pub fn failure_then<T, M: FnOnce(E) -> Outcome<S, T, F>>(
    self,
    f: M
) -> Outcome<S, T, F>
[src]

Converts from Outcome<S, E, F> to Outcome<S, T, F> using f to map Failure(E) to Failure(T).

If self is not Failure, self is returned.

Examples

let x: Outcome<i32, &str, bool> = Failure("hi");

let mapped = x.failure_then(|v| match v {
   "hi" => Failure(10),
   "test" => Forward(false),
   _ => Success(10)
});

assert_eq!(mapped, Failure(10));

pub fn forward_then<T, M: FnOnce(F) -> Outcome<S, E, T>>(
    self,
    f: M
) -> Outcome<S, E, T>
[src]

Converts from Outcome<S, E, F> to Outcome<S, E, T> using f to map Forward(F) to Forward(T).

If self is not Forward, self is returned.

Examples

let x: Outcome<i32, &str, Option<bool>> = Forward(Some(false));

let mapped = x.forward_then(|v| match v {
   Some(true) => Success(10),
   Some(false) => Forward(20),
   None => Failure("10")
});

assert_eq!(mapped, Forward(20));

pub fn ok_map_forward<M>(self, f: M) -> Result<S, E> where
    M: FnOnce(F) -> Result<S, E>, 
[src]

Converts Outcome<S, E, F> to Result<S, E> by identity mapping Success(S) and Failure(E) to Result<T, E> and mapping Forward(F) to Result<T, E> using f.

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.ok_map_forward(|x| Ok(x as i32 + 1)), Ok(10));

let x: Outcome<i32, &str, usize> = Failure("hello");
assert_eq!(x.ok_map_forward(|x| Ok(x as i32 + 1)), Err("hello"));

let x: Outcome<i32, &str, usize> = Forward(0);
assert_eq!(x.ok_map_forward(|x| Ok(x as i32 + 1)), Ok(1));

pub fn ok_map_failure<M>(self, f: M) -> Result<S, F> where
    M: FnOnce(E) -> Result<S, F>, 
[src]

Converts Outcome<S, E, F> to Result<S, E> by identity mapping Success(S) and Forward(F) to Result<T, F> and mapping Failure(E) to Result<T, F> using f.

let x: Outcome<i32, &str, usize> = Success(10);
assert_eq!(x.ok_map_failure(|s| Ok(123)), Ok(10));

let x: Outcome<i32, &str, usize> = Failure("hello");
assert_eq!(x.ok_map_failure(|s| Ok(123)), Ok(123));

let x: Outcome<i32, &str, usize> = Forward(0);
assert_eq!(x.ok_map_failure(|s| Ok(123)), Err(0));

impl<'a, S: Send + 'a, E: Send + 'a, F: Send + 'a> Outcome<S, E, F>[src]

pub fn pin(self) -> BoxFuture<'a, Self>[src]

Pins a future that resolves to self, returning a BoxFuture that resolves to self.

impl<'r, 'o: 'r> Outcome<Response<'r>, Status, Data<'r>>[src]

pub fn from<R: Responder<'r, 'o>>(
    req: &'r Request<'_>,
    responder: R
) -> Outcome<'r>
[src]

Return the Outcome of response to req from responder.

If the responder returns Ok, an outcome of Success is returned with the response. If the responder returns Err, an outcome of Failure is returned with the status code.

Example

use rocket::{Request, Data, route};

fn str_responder<'r>(req: &'r Request, _: Data<'r>) -> route::Outcome<'r> {
    route::Outcome::from(req, "Hello, world!")
}

pub fn try_from<R, E>(req: &'r Request<'_>, result: Result<R, E>) -> Outcome<'r> where
    R: Responder<'r, 'o>,
    E: Debug
[src]

Return the Outcome of response to req from responder.

If the responder returns Ok, an outcome of Success is returned with the response. If the responder returns Err, an outcome of Failure is returned with the status code.

Example

use rocket::{Request, Data, route};

fn str_responder<'r>(req: &'r Request, _: Data<'r>) -> route::Outcome<'r> {
    route::Outcome::from(req, "Hello, world!")
}

pub fn from_or_forward<R>(
    req: &'r Request<'_>,
    data: Data<'r>,
    responder: R
) -> Outcome<'r> where
    R: Responder<'r, 'o>, 
[src]

Return the Outcome of response to req from responder.

If the responder returns Ok, an outcome of Success is returned with the response. If the responder returns Err, an outcome of Forward is returned.

Example

use rocket::{Request, Data, route};

fn str_responder<'r>(req: &'r Request, data: Data<'r>) -> route::Outcome<'r> {
    route::Outcome::from_or_forward(req, data, "Hello, world!")
}

pub fn failure(code: Status) -> Outcome<'r>[src]

Return an Outcome of Failure with the status code code. This is equivalent to Outcome::Failure(code).

This method exists to be used during manual routing.

Example

use rocket::{Request, Data, route};
use rocket::http::Status;

fn bad_req_route<'r>(_: &'r Request, _: Data<'r>) -> route::Outcome<'r> {
    route::Outcome::failure(Status::BadRequest)
}

pub fn forward(data: Data<'r>) -> Outcome<'r>[src]

Return an Outcome of Forward with the data data. This is equivalent to Outcome::Forward(data).

This method exists to be used during manual routing.

Example

use rocket::{Request, Data, route};

fn always_forward<'r>(_: &'r Request, data: Data<'r>) -> route::Outcome<'r> {
    route::Outcome::forward(data)
}

Trait Implementations

impl<S: Clone, E: Clone, F: Clone> Clone for Outcome<S, E, F>[src]

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

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<S, E, F> Debug for Outcome<S, E, F>[src]

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

Formats the value using the given formatter. Read more

impl<S, E, F> Display for Outcome<S, E, F>[src]

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

Formats the value using the given formatter. Read more

impl<S: Hash, E: Hash, F: Hash> Hash for Outcome<S, E, F>[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

Feeds this value into the given Hasher. Read more

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

Feeds a slice of this type into the given Hasher. Read more

impl<S: Ord, E: Ord, F: Ord> Ord for Outcome<S, E, F>[src]

fn cmp(&self, other: &Outcome<S, E, F>) -> Ordering[src]

This method returns an Ordering between self and other. Read more

#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]

Restrict a value to a certain interval. Read more

impl<S: PartialEq, E: PartialEq, F: PartialEq> PartialEq<Outcome<S, E, F>> for Outcome<S, E, F>[src]

fn eq(&self, other: &Outcome<S, E, F>) -> bool[src]

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

fn ne(&self, other: &Outcome<S, E, F>) -> bool[src]

This method tests for !=.

impl<S: PartialOrd, E: PartialOrd, F: PartialOrd> PartialOrd<Outcome<S, E, F>> for Outcome<S, E, F>[src]

fn partial_cmp(&self, other: &Outcome<S, E, F>) -> Option<Ordering>[src]

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

#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

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

impl<S: Copy, E: Copy, F: Copy> Copy for Outcome<S, E, F>[src]

impl<S: Eq, E: Eq, F: Eq> Eq for Outcome<S, E, F>[src]

impl<S, E, F> StructuralEq for Outcome<S, E, F>[src]

impl<S, E, F> StructuralPartialEq for Outcome<S, E, F>[src]

Auto Trait Implementations

impl<S, E, F> RefUnwindSafe for Outcome<S, E, F> where
    E: RefUnwindSafe,
    F: RefUnwindSafe,
    S: RefUnwindSafe

impl<S, E, F> Send for Outcome<S, E, F> where
    E: Send,
    F: Send,
    S: Send

impl<S, E, F> Sync for Outcome<S, E, F> where
    E: Sync,
    F: Sync,
    S: Sync

impl<S, E, F> Unpin for Outcome<S, E, F> where
    E: Unpin,
    F: Unpin,
    S: Unpin

impl<S, E, F> UnwindSafe for Outcome<S, E, F> where
    E: UnwindSafe,
    F: UnwindSafe,
    S: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized
[src]

pub fn equivalent(&self, key: &K) -> bool[src]

Compare self to key and return true if they are equal.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> IntoCollection<T> for T

pub fn into_collection<A>(self) -> SmallVec<A> where
    A: Array<Item = T>, 

Converts self into a collection.

pub fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
    F: FnMut(T) -> U,
    A: Array<Item = U>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
    T: Display + ?Sized
[src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V