qubit-cas 0.8.0

Typed compare-and-swap executor with retry-aware conflict handling
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
//! Terminal fast compare-and-swap failures.

/// Terminal [`crate::FastCas`] failure.
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum FastCasError<E> {
    /// The operation aborted from a user decision.
    Abort {
        /// State observed by the aborting attempt.
        current: usize,

        /// Business error returned by the operation.
        error: E,

        /// Number of attempts consumed before aborting.
        attempts: u32,
    },

    /// CAS conflicts exhausted the retry policy.
    Conflict {
        /// Most recent state observed after the final failed CAS.
        current: usize,

        /// Number of attempts consumed before giving up.
        attempts: u32,
    },
}

impl<E> FastCasError<E> {
    /// Returns the current state captured by the terminal failure.
    ///
    /// # Returns
    /// The observed state code at failure.
    #[inline]
    pub const fn current(&self) -> usize {
        match self {
            Self::Abort { current, .. } | Self::Conflict { current, .. } => *current,
        }
    }

    /// Returns the number of attempts consumed before failure.
    ///
    /// # Returns
    /// Number of attempts executed by the operation.
    #[inline]
    pub const fn attempts(&self) -> u32 {
        match self {
            Self::Abort { attempts, .. } | Self::Conflict { attempts, .. } => *attempts,
        }
    }

    /// Tests whether this failure came from an abort decision.
    ///
    /// # Returns
    /// `true` for [`FastCasError::Abort`].
    #[inline]
    pub const fn is_abort(&self) -> bool {
        matches!(self, Self::Abort { .. })
    }

    /// Tests whether this failure came from exhausted CAS conflicts.
    ///
    /// # Returns
    /// `true` for [`FastCasError::Conflict`].
    #[inline]
    pub const fn is_conflict(&self) -> bool {
        matches!(self, Self::Conflict { .. })
    }

    /// Returns the business error for abort failures.
    ///
    /// # Returns
    /// `Some(error)` for abort failures, or `None` for conflict failures.
    #[inline]
    pub const fn error(&self) -> Option<&E> {
        match self {
            Self::Abort { error, .. } => Some(error),
            Self::Conflict { .. } => None,
        }
    }

    /// Consumes this failure and returns the business error when present.
    ///
    /// # Returns
    /// `Some(error)` for abort failures, or `None` for conflict failures.
    #[inline]
    pub fn into_error(self) -> Option<E> {
        match self {
            Self::Abort { error, .. } => Some(error),
            Self::Conflict { .. } => None,
        }
    }
}