Struct AtomicLog 

pub struct AtomicLog<T> { /* private fields */ }

Shared read handle for a segmented rolling log.

AtomicLog<T> is cheaply clonable and can be sent to many reader threads. Readers use snapshot to capture a stable, zero-copy view of the currently retained data.

Implementations

impl<T> AtomicLog<T>

pub fn new(retained_capacity: usize, segment_capacity: usize) -> Self

Creates a new log without claiming a writer.

retained_capacity is the target logical retention size in elements. The current implementation retains whole segments, so the observed window may exceed this value.

segment_capacity is the number of elements stored in each segment and remains fixed for the lifetime of the log.

Panics

Panics if either capacity is zero.

pub fn new_claimed( retained_capacity: usize, segment_capacity: usize, ) -> (Writer<T>, Self)

Creates a new log and immediately claims its writer.

pub fn retained_capacity(&self) -> usize

Returns the configured logical retained capacity, in elements.

pub fn segment_capacity(&self) -> usize

Returns the fixed segment size, in elements.

pub fn is_writer_claimed(&self) -> bool

Returns true if this log currently has a claimed writer.

pub fn snapshot(&self) -> Snapshot<T>

Captures a stable snapshot of the currently retained data.

The snapshot borrows no locks and keeps its backing segments alive through Arc ownership, so readers can iterate over the result without copying values out of the log.

pub fn try_claim_writer(&self) -> Option<Writer<T>>

Attempts to claim exclusive write access to this log.

Returns None if another Writer currently exists. Dropping the returned writer releases the claim without discarding the log’s retained segment state.

Trait Implementations

impl<T> Clone for AtomicLog<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> From<AtomicLog<T>> for Snapshot<T>

fn from(log: AtomicLog<T>) -> Self

Converts to this type from the input type.

impl<T> From<Snapshot<T>> for AtomicLog<T>

fn from(snapshot: Snapshot<T>) -> Self

Converts to this type from the input type.

impl<T> From<Writer<T>> for AtomicLog<T>

fn from(writer: Writer<T>) -> Self

Converts to this type from the input type.