Enum TransactionResult 

pub enum TransactionResult<T = ()> {
    Action(Action),
    Value(T),
}

Result of a single execution of a transaction attempt closure passed to until_done.

Variants

Action(Action)

The transaction must back off or restart and re-execute the closure.

Value(T)

The transaction completed with the terminal value T.

Implementations

impl TransactionResult<()>

pub const DONE: Self

Convenience constant for completing a ()-returning transaction.

impl<T> TransactionResult<T>

pub const BACKOFF: Self

Convenience constant for requesting a transaction backoff.

pub const RESTART: Self

Convenience constant for requesting a transaction restart.

pub const fn is_action(&self) -> bool

Returns true if this result is an Action.

pub fn action(&self) -> Action

Returns the Action contained in this result.

Panics

Panics if !self.is_action().

pub fn take_value(self) -> T

Consumes this result and returns the terminal value T.

Panics

Panics if self.is_action().

Trait Implementations

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

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

Formats the value using the given formatter.

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

impl<T> From<Action> for TransactionResult<T>

fn from(action: Action) -> Self

Converts to this type from the input type.

impl From<DoneType> for TransactionResult<()>

fn from(_: DoneType) -> Self

Converts to this type from the input type.

impl<T> IntoTransactionResult for TransactionResult<T>

type Output = T

The terminal value type returned by until_done when the transaction completes.

fn into_transaction_result(self) -> TransactionResult<T>

Converts the closure return value into a TransactionResult.

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

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for TransactionResult<T>