Skip to main content

HistoryCacheStats

Struct HistoryCacheStats 

Source
pub struct HistoryCacheStats {
    pub len: AtomicUsize,
    pub evicted: AtomicU64,
    pub max_sn: AtomicI64,
    pub min_sn: AtomicI64,
}
Expand description

Atomically updated snapshot statistics of a HistoryCache.

Note: the actual BTreeMap storage of the cache still needs &mut self to mutate (concurrent read/write BTreeMap mutation does not exist in std), but statistics values (length, max/min SN, eviction counter) are carried in parallel in an Arc<HistoryCacheStats>. Monitoring threads, SEDP tick loops and telemetry can thus poll lock-free, without taking the writer/reader lock.

Consistency guarantee: every mutating method of the cache updates the atomics after the BTreeMap mutation, with Release ordering. Readers use Acquire ordering — they see a consistent state of the last completed cache operation, never a half-updated state of the individual atomics.

What is not guaranteed: cross-field consistency. If a reader reads len and then max_sn, further inserts can have happened between the loads. That is acceptable for monitoring; for hard wire paths (heartbeat build) the writer lock is still taken.

Fields§

§len: AtomicUsize

Number of changes in the cache (corresponds to BTreeMap::len).

§evicted: AtomicU64

Number of samples discarded by KeepLast eviction since start.

§max_sn: AtomicI64

Highest SN in the cache, or [STATS_SENTINEL_NO_SN] if empty.

§min_sn: AtomicI64

Lowest SN in the cache, or [STATS_SENTINEL_NO_SN] if empty.

Implementations§

Source§

impl HistoryCacheStats

Source

pub fn snapshot(&self) -> HistoryCacheSnapshot

Snapshot of the four atomics as a plain-old-data struct. Loaded with Acquire ordering — synchronized with the Release store in HistoryCache::insert / HistoryCache::remove_up_to.

Trait Implementations§

Source§

impl Clone for HistoryCacheStats

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HistoryCacheStats

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HistoryCacheStats

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.