Enum Finalizable

pub enum Finalizable<T> {
    Working(T),
    Finalized(T),
}

A value that can be a working value or a finalized value. All operations on a single Finalizable<T> do not modify a finalized value.

Variants

Working(T)

A working value.

Finalized(T)

A finalized value.

Implementations

impl<T> Finalizable<T>

pub fn new(value: T, finalized: bool) -> Self

Create a new finalizable value from a value and a boolean that determines if it is a finalized or working value.

pub fn finalize(self) -> Self

Finalize a value. Returns a finalized version of the value.

pub fn get(self) -> T

Get the value, whether working or finalized.

pub fn get_as_ref(&self) -> &T

Get the value from a reference to a finalizable value, whether working or finalized, as a reference to the underlying value.

pub fn try_get_mut(&mut self) -> Option<&mut T>

Get the value from a mutable reference to a working value as a mutable reference. Returns None if the value is a finalized value.

pub fn set(self, value: T) -> Self

Override a working value. Does nothing to a finalized value.

pub fn is_working(&self) -> bool

Check if a value is a working value.

pub fn is_finalized(&self) -> bool

Check if a value is a finalized value.

pub fn working_or_none(self) -> Option<T>

Get the value, but only if it is a working value. Returns None if the value is a finalized value.

pub fn finalized_or_none(self) -> Option<T>

Get the value, but only if it is a finalized value. Returns None if the value is a working value.

pub fn finalized_or(self, default: T) -> T

Get the value, but only if it is a finalized value. Returns default if the value is a working value.

pub fn finalized_or_else<F: FnOnce(T) -> T>(self, op: F) -> T

Get the value, but only if it is a finalized value. Calls default and returns its result if the value is a working value.

pub fn as_ref(&self) -> Finalizable<&T>

Turn a reference to a finalizable value into a finalizable reference.

pub fn map<F: FnOnce(T) -> T>(self, op: F) -> Self

Apply a function to a working value. Does nothing to a finalized value.

pub fn map_and_finalize<F: FnOnce(T) -> T>(self, op: F) -> Self

Apply a function to a working value and finalize it. Does nothing to a finalized value.

pub fn expect_finalized(self, msg: &str) -> T

Get a finalized value, panicking with msg if the value is a working value.

pub fn and(self, fin: Self) -> Self

Return fin if the value is a working value, returning a finalized value unchanged.

pub fn and_then<F: FnOnce(T) -> Self>(self, op: F) -> Self

Call op on the value if it is a working value, returning a finalized value unchanged.

pub fn and_then_new<F: FnOnce(T) -> (T, bool)>(self, op: F) -> Self

Call op on the value if it is a working value, creating a new finalizable value by using the returned tuple as the arguments to new, returning a finalized value unchanged.

impl<T> Finalizable<&T>

pub fn copied(self) -> Finalizable<T>

where T: Copy,

Make a copy of a finalizable value by copying the underlying value.

pub fn cloned(self) -> Finalizable<T>

where T: Clone,

Make a clone of a finalizable value by cloning the underlying value.

Trait Implementations

impl<T: Clone> Clone for Finalizable<T>

fn clone(&self) -> Finalizable<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Finalizable<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Finalizable<T>

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> Ord for Finalizable<T>

fn cmp(&self, other: &Finalizable<T>) -> 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,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Finalizable<T>

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

fn partial_cmp(&self, other: &Finalizable<T>) -> 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: Copy> Copy for Finalizable<T>

impl<T: Eq> Eq for Finalizable<T>

impl<T> StructuralPartialEq for Finalizable<T>