Struct orx_concurrent_iter::AtomicCounter

pub struct AtomicCounter { /* private fields */ }

An atomic counter, simply a wrapper around AtomicUsize with utility methods useful for atomic iterators.

Implementations

impl AtomicCounter

pub fn new() -> Self

Creates a new atomic counter with its value initiated at zero.

pub fn fetch_and_add(&self, len: usize) -> usize

Fetches and returns the current value of the counter, and adds len to it.

pub fn fetch_and_increment(&self) -> usize

Fetches and returns the current value of the counter, and adds 1 to it.

pub fn current(&self) -> usize

Fetches and returns the current value of the counter.

pub fn store(&self, new_value: usize)

Updates the value of the current value of the counter as the given new_value.

pub fn get_current_max_value(&self, max_value: usize) -> usize

Updates the current value to the max of the current and provided max_value, and returns the previous value.

This method is most useful for early exits and concurrently consuming the iterator.

Trait Implementations

impl Clone for AtomicCounter

fn clone(&self) -> Self

Clones the atomic counter with its current 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

Creates a new atomic counter with its value initiated at zero.