Enum CasSuccess 

pub enum CasSuccess<T, R> {
    Updated {
        previous: Arc<T>,
        current: Arc<T>,
        output: R,
        context: CasContext,
    },
    Finished {
        current: Arc<T>,
        output: R,
        context: CasContext,
    },
}

Successful result returned by crate::CasExecutor.

Variants

Updated

The executor installed a new state by compare-and-swap.

Fields

previous: Arc<T>

Previous state observed by the successful attempt.

current: Arc<T>

Current state after the successful update.

output: R

Business output returned by the operation.

context: CasContext

Retry context captured when the flow completed.

Finished

The executor finished successfully without writing a new state.

Fields

current: Arc<T>

Current state that remained installed.

output: R

Business output returned by the operation.

context: CasContext

Retry context captured when the flow completed.

Implementations

impl<T, R> CasSuccess<T, R>

pub fn is_updated(&self) -> bool

Returns whether this success performed a write.

Returns

true for CasSuccess::Updated, false for CasSuccess::Finished.

pub fn previous(&self) -> Option<&Arc<T>>

Returns the previous state when a write occurred.

Returns

Some(&Arc<T>) for CasSuccess::Updated, or None when no write occurred.

pub fn current(&self) -> &Arc<T>

Returns the current state after success.

Returns

Shared reference to the current state.

pub fn output(&self) -> &R

Returns the business output.

Returns

Shared reference to the business output.

pub fn into_output(self) -> R

Consumes the success result and returns the business output.

Returns

The owned business output.

pub fn context(&self) -> CasContext

Returns the retry context captured at success.

Returns

Retry context for the completed flow.

pub fn attempts(&self) -> u32

Returns the number of attempts that were executed.

Returns

One-based attempt count.

Trait Implementations

impl<T: Clone, R: Clone> Clone for CasSuccess<T, R>

fn clone(&self) -> CasSuccess<T, R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, R: Debug> Debug for CasSuccess<T, R>

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

Formats the value using the given formatter.

impl<T: PartialEq, R: PartialEq> PartialEq for CasSuccess<T, R>

fn eq(&self, other: &CasSuccess<T, R>) -> 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: Eq, R: Eq> Eq for CasSuccess<T, R>

impl<T, R> StructuralPartialEq for CasSuccess<T, R>