Struct AtomicCounter 

pub struct AtomicCounter { /* private fields */ }

A thread-safe atomic counter with increment and decrement operations.

This counter uses relaxed ordering for maximum performance while maintaining atomicity across threads.

Implementations

impl AtomicCounter

pub const fn new() -> Self

Create a new atomic counter with initial value 0.

pub const fn with_initial(initial: usize) -> Self

Create a new atomic counter with the given initial value.

pub fn get(&self) -> usize

Get the current value of the counter.

pub fn set(&self, value: usize)

Set the counter to a specific value.

pub fn increment(&self) -> usize

Increment the counter by 1 and return the previous value.

pub fn add(&self, amount: usize) -> usize

Increment the counter by a specific amount and return the previous value.

pub fn fetch_add(&self, amount: usize, ordering: Ordering) -> usize

Atomic fetch-and-add operation compatible with std::sync::atomic interface. This provides a lower-level interface for compatibility.

pub fn decrement(&self) -> usize

Decrement the counter by 1 and return the previous value. Note: This will wrap around on underflow.

pub fn subtract(&self, amount: usize) -> usize

Decrement the counter by a specific amount and return the previous value. Note: This will wrap around on underflow.

pub fn max(&self, value: usize) -> usize

Atomically set the counter to the maximum of its current value and the given value.

pub fn min(&self, value: usize) -> usize

Atomically set the counter to the minimum of its current value and the given value.

pub fn reset(&self) -> usize

Reset the counter to 0 and return the previous value.

pub fn compare_and_swap(&self, current: usize, new: usize) -> (usize, bool)

Compare and swap the counter value. Returns the previous value and whether the swap was successful.

Trait Implementations

impl Clone for AtomicCounter

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AtomicCounter

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

Formats the value using the given formatter.

impl Default for AtomicCounter

fn default() -> Self

Returns the “default value” for a type.