Enum TransactionResult

pub enum TransactionResult<T, E> {
    Validated(T),
    Cancelled(E),
    Abandoned,
}

Result of a fallible transaction.

A given transaction can finish in three different ways:

• it is validated, and possibly returns an output value,
• it is manually cancelled, and possibly returns a user-defined error,
• it is cancelled through regular STM control flow.

Each variant of this enum represents a case. All of the associated methods behave like their equivalent for std::result::Result.

Variants

Validated(T)

Transaction completed successfully.

Cancelled(E)

Transaction was manually aborted.

Abandoned

Transaction was aorted through standard control flow.

Implementations

impl<T, E> TransactionResult<T, E>

pub fn is_validated(&self) -> bool

Returns true if the result is Validated.

pub fn is_validated_and(self, f: impl FnOnce(T) -> bool) -> bool

Returns true if the result is Validated and the value inside of it matches a predicate.

pub fn is_cancelled(&self) -> bool

Returns true if the result is Cancelled.

pub fn is_cancelled_and(self, f: impl FnOnce(E) -> bool) -> bool

Returns true if the result is Cancelled and the value inside of it matches a predicate.

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

Converts self: TransactionResult<T, E> to Option<T>, consuming self, and discarding the error, if any.

pub fn cancelled(self) -> Option<E>

Converts self: TransactionResult<T, E> to Option<E>, consuming self, and discarding the success value, if any.

pub fn failed(self) -> bool

Returns true if the result is Abandoned.

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

where E: Debug,

Returns the contained Validated value, consuming self.

Panics

Panics if the value is a Cancelled or Abandoned, with a panic message including the passed message, and the content of Cancelled if applicable.

pub fn expect_err(self, msg: &str) -> E

where T: Debug,

Returns the contained Cancelled error, consuming self.

Panics

Panics if the value is a Validated or Abandoned, with a panic message including the passed message, and the content of Validated if applicable.

pub fn unwrap(self) -> T

where E: Debug,

Returns the contained Validated value, consuming self.

Panics

Panics if the value is a Cancelled or Abandoned, with a panic message specified by the content of Cancelled if applicable.

pub fn unwrap_err(self) -> E

where T: Debug,

Returns the contained Cancelled error, consuming self.

Panics

Panics if the value is a Validated or Abandoned, with a panic message specified by the content of Validated if applicable.

pub fn unwrap_or_default(self) -> T

where T: Default,

Returns the contained Validated value or a default value, consuming self.

If the value is a Cancelled or Abandoned, the Default implementation of T is called to return a value.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn eq(&self, other: &TransactionResult<T, E>) -> 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: Copy, E: Copy> Copy for TransactionResult<T, E>

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

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