Struct GenerationCounter 

pub struct GenerationCounter { /* private fields */ }

Atomic generation counter for tracking buffer lifecycle events.

This counter provides thread-safe tracking of buffer state changes throughout its lifecycle. Each buffer operation (allocation, use, reuse) can increment the generation to help with debugging buffer lifecycle issues and detecting use-after-free scenarios in development builds.

The counter uses relaxed atomic ordering since exact ordering of generation updates across threads is not critical for its debugging purposes.

Thread Safety

All operations on GenerationCounter are thread-safe and can be called concurrently from multiple threads.

Examples

use safer_ring::buffer::GenerationCounter;

let counter = GenerationCounter::new();
assert_eq!(counter.get(), 0);

counter.increment();
assert_eq!(counter.get(), 1);

counter.set(42);
assert_eq!(counter.get(), 42);

Implementations

impl GenerationCounter

pub const fn new() -> Self

Creates a new generation counter starting at 0.

pub fn get(&self) -> u64

Returns the current generation value.

pub fn increment(&self)

Increments the generation counter atomically.

pub fn set(&self, value: u64)

Sets the generation counter to a specific value.

Trait Implementations

impl Clone for GenerationCounter

fn clone(&self) -> Self

Creates a new counter with the same generation value.

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

Performs copy-assignment from source.

impl Debug for GenerationCounter

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

Formats the value using the given formatter.

impl Default for GenerationCounter

fn default() -> Self

Returns the “default value” for a type.