Skip to main content

CasAttemptFailure

qubit_cas::error

Enum CasAttemptFailure

pub enum CasAttemptFailure<T, E> {
    Conflict {
        current: Arc<T>,
    },
    Retry {
        current: Arc<T>,
        error: E,
    },
    Abort {
        current: Arc<T>,
        error: E,
    },
    Timeout {
        current: Arc<T>,
    },
}

Expand description

Failure produced by one CAS attempt.

Variants§

Conflict

Compare-and-swap failed because another writer changed the state first.

Fields

§current: Arc<T>

State observed after the conflict.

Retry

Business logic requested another attempt.

Fields

§current: Arc<T>

Current state for the failed attempt.

§error: E

Retryable business error.

Abort

Business logic aborted the CAS flow.

Fields

§current: Arc<T>

Current state for the failed attempt.

§error: E

Terminal business error.

Timeout

One async attempt exceeded the configured timeout.

Fields

§current: Arc<T>

State snapshot used by the timed-out attempt.

Implementations§

impl<T, E> CasAttemptFailure<T, E>

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

Returns the state snapshot associated with this failure.

§Returns

Shared reference to the current state.

pub fn kind(&self) -> CasAttemptFailureKind

Returns the lightweight kind of this attempt failure.

§Returns

The CasAttemptFailureKind matching this failure variant.

pub fn error(&self) -> Option<&E>

Returns the business error when this failure carries one.

§Returns

Some(&E) for CasAttemptFailure::Retry and CasAttemptFailure::Abort, or None otherwise.

pub fn is_conflict(&self) -> bool

Returns whether this failure is a compare-and-swap conflict.

§Returns

true for CasAttemptFailure::Conflict.

pub fn is_retry(&self) -> bool

Returns whether this failure is a retryable business error.

§Returns

true for CasAttemptFailure::Retry.

pub fn is_abort(&self) -> bool

Returns whether this failure aborts the CAS flow.

§Returns

true for CasAttemptFailure::Abort.

pub fn is_timeout(&self) -> bool

Returns whether this failure came from an async timeout.

§Returns

true for CasAttemptFailure::Timeout.

Trait Implementations§

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

fn clone(&self) -> CasAttemptFailure<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 CasAttemptFailure<T, E>

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

Formats the value using the given formatter. Read more

impl<T, E> Display for CasAttemptFailure<T, E>
where E: Display,

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

Formats the attempt failure for diagnostics.

§Parameters

f: Formatter provided by the standard formatting machinery.

§Returns

fmt::Result from the formatter.

§Errors

Returns a formatting error if the formatter fails.

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

fn eq(&self, other: &CasAttemptFailure<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: Eq, E: Eq> Eq for CasAttemptFailure<T, E>

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

Auto Trait Implementations§

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

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

impl<T, E> Send for CasAttemptFailure<T, E>
where E: Send, T: Sync + Send,

impl<T, E> Sync for CasAttemptFailure<T, E>
where E: Sync, T: Sync + Send,

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

impl<T, E> UnsafeUnpin for CasAttemptFailure<T, E>
where E: UnsafeUnpin,

impl<T, E> UnwindSafe for CasAttemptFailure<T, E>
where E: UnwindSafe, T: RefUnwindSafe,

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> IntoResult<T> for T

type Err = Infallible

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

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> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. 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.