libflate::finish

Struct Finish

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

Expand description

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

Implementations§

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 duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

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

Returns the “default value” for a type. Read more

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

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

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

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. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

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

Restrict a value to a certain interval. Read more

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

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 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. Read more

1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

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

1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

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

1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

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

1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

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

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

impl<T, E> StructuralPartialEq for Finish<T, E>

Auto Trait Implementations§

impl<T, E> Freeze for Finish<T, E>
where T: Freeze, E: Freeze,

impl<T, E> RefUnwindSafe for Finish<T, E>
where T: RefUnwindSafe, E: RefUnwindSafe,

impl<T, E> Send for Finish<T, E>
where T: Send, E: Send,

impl<T, E> Sync for Finish<T, E>
where T: Sync, E: Sync,

impl<T, E> Unpin for Finish<T, E>
where T: Unpin, E: Unpin,

impl<T, E> UnwindSafe for Finish<T, E>
where T: UnwindSafe, E: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

The type returned in the event of a conversion error.

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

Performs the conversion.