Struct libflate::finish::Finish

pub struct Finish<T, E> { /* fields omitted */ }

Finish is a type that represents a value which may have an error occurred during the computation.

Logically, Finish<T, E> is equivalent to Result<T, (T, E)>.

Methods

impl<T, E> Finish<T, E>

pub fn new(value: T, error: Option<E>) -> Self

Makes a new instance.

Examples

use libflate::Finish;

// The result value of a succeeded computation
let succeeded = Finish::new("value", None as Option<()>);
assert_eq!(succeeded.into_result(), Ok("value"));

// The result value of a failed computation
let failed = Finish::new("value", Some("error"));
assert_eq!(failed.into_result(), Err("error"));

pub fn unwrap(self) -> (T, Option<E>)

Unwraps the instance.

Examples

use libflate::Finish;

let succeeded = Finish::new("value", None as Option<()>);
assert_eq!(succeeded.unwrap(), ("value", None));

let failed = Finish::new("value", Some("error"));
assert_eq!(failed.unwrap(), ("value", Some("error")));

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

Converts from Finish<T, E> to Result<T, E>.

Examples

use libflate::Finish;

let succeeded = Finish::new("value", None as Option<()>);
assert_eq!(succeeded.into_result(), Ok("value"));

let failed = Finish::new("value", Some("error"));
assert_eq!(failed.into_result(), Err("error"));

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

Converts from Finish<T, E> to Result<&T, &E>.

Examples

use libflate::Finish;

let succeeded = Finish::new("value", None as Option<()>);
assert_eq!(succeeded.as_result(), Ok(&"value"));

let failed = Finish::new("value", Some("error"));
assert_eq!(failed.as_result(), Err(&"error"));

Trait Implementations

impl<T: Clone, E: Clone> Clone for Finish<T, E>

fn clone(&self) -> Finish<T, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq, E: PartialEq> PartialEq<Finish<T, E>> for Finish<T, E>

fn eq(&self, other: &Finish<T, E>) -> bool

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

fn ne(&self, other: &Finish<T, E>) -> bool

This method tests for !=.

impl<T: PartialOrd, E: PartialOrd> PartialOrd<Finish<T, E>> for Finish<T, E>

fn partial_cmp(&self, other: &Finish<T, E>) -> Option<Ordering>

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

fn lt(&self, other: &Finish<T, E>) -> bool

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

fn le(&self, other: &Finish<T, E>) -> bool

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

fn gt(&self, other: &Finish<T, E>) -> bool

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

fn ge(&self, other: &Finish<T, E>) -> bool

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

impl<T: Eq, E: Eq> Eq for Finish<T, E>

impl<T: Default, E: Default> Default for Finish<T, E>

fn default() -> Finish<T, E>

Returns the "default value" for a type.

impl<T: Ord, E: Ord> Ord for Finish<T, E>

fn cmp(&self, other: &Finish<T, E>) -> Ordering

This method returns an Ordering between self and other.

default fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

default fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

default fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

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

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

Feeds this value into the given [Hasher].

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

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

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

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

Formats the value using the given formatter.