Struct Logger 

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

The main logger struct responsible for handling log writing and reading operations. It uses a ring buffer and a background worker thread for asynchronous logging.

Implementations

impl<T: Send + Sync + Default + Copy + 'static> Logger<T>

pub fn new() -> Self

Creates a new instance of Logger with default (empty) configuration.

pub fn with_write_config( self, logpath: String, capacity: usize, flush_interval: u64, poll_interval: u64, pre_alloc_size: u64, ) -> Self

Configures the logger for writing logs.

Arguments

• logpath - Path to the log file.
• capacity - Size of the ring buffer.
• flush_interval - Interval in nanoseconds to flush logs to disk.
• poll_interval - Interval in nanoseconds to poll for uring completions.
• pre_alloc_size - Size in bytes to pre-allocate for the log file.

pub fn start(&mut self) -> Result<(), Error>

Initializes the internal components (buffer, worker thread) and starts the logging process.

Returns

• Result<(), Error> - Ok if started successfully, Err if configuration is missing.

pub fn with_read_config(self, logpath: String) -> Self

Configures the logger for reading logs.

Arguments

• logpath - Path to the log file to read from.

pub fn read(&self) -> Result<Vec<T>, Error>

Reads all log entries from the configured log file.

Returns

• Result<Vec<T>, Error> - A vector of log data if successful, or an error.

pub fn log(&mut self, data: T) -> Option<u64>

Adds a new log entry to the buffer.

Arguments

• data - The log data to be written.

Returns

• Option<u64> - The sequence ID of the log entry if successful, or None if the logger is not started.

pub fn get_last_flushed_entry() -> u64

Retrieves the sequence ID of the last log entry that was successfully flushed to disk.

Returns

• u64 - The sequence ID.

Trait Implementations

impl<T> Drop for Logger<T>

fn drop(&mut self)

Executes the destructor for this type.