qubit-cas 0.4.2

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

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/

use crate::report::CasExecutionReport;

use super::ContentionThresholds;

/// Alert emitted when an execution crosses configured contention thresholds.
#[derive(Debug, Clone)]
pub struct CasAlert {
    /// Report that triggered the alert.
    report: CasExecutionReport,
    /// Thresholds that were crossed.
    thresholds: ContentionThresholds,
}

impl CasAlert {
    /// Creates a contention alert.
    ///
    /// # Parameters
    /// - `report`: The execution report that crossed thresholds.
    /// - `thresholds`: The thresholds that were exceeded.
    ///
    /// # Returns
    /// A new [`CasAlert`] value.
    #[inline]
    pub(crate) fn contention(report: CasExecutionReport, thresholds: ContentionThresholds) -> Self {
        Self { report, thresholds }
    }

    /// Returns the report that triggered this alert.
    ///
    /// # Returns
    /// Reference to the [`CasExecutionReport`] that caused the alert.
    #[inline]
    pub fn report(&self) -> &CasExecutionReport {
        &self.report
    }

    /// Returns the thresholds that were crossed.
    ///
    /// # Returns
    /// The [`ContentionThresholds`] used for this alert.
    #[inline]
    pub fn thresholds(&self) -> ContentionThresholds {
        self.thresholds
    }
}