Struct RotatingLog

pub struct RotatingLog { /* private fields */ }

A rotating log file that automatically rotates when reaching a maximum size.

The log rotation process preserves the last full log file with a “.old” extension while continuing to write to a new log file with the original name.

Example

use microsandbox_utils::log::RotatingLog;

#[tokio::main]
async fn main() -> std::io::Result<()> {
    let log = RotatingLog::new("app.log").await?; // 1MB max size
    Ok(())
}

Implementations

impl RotatingLog

pub async fn new(path: impl AsRef<Path>) -> Result<Self>

Creates a new rotating log file with the default maximum size.

This is a convenience wrapper around [with_max_size] that uses the default maximum log file size defined in DEFAULT_LOG_MAX_SIZE.

Arguments

• path - Path to the log file

Errors

Will return an error if:

• The file cannot be created or opened
• File metadata cannot be read

pub async fn with_max_size( path: impl AsRef<Path>, max_size: u64, ) -> Result<Self>

Creates a new rotating log file.

Errors

Will return an error if:

• The file cannot be created or opened
• File metadata cannot be read

pub fn get_sync_writer(&self) -> SyncChannelWriter

Get a sync writer that implements std::io::Write

Trait Implementations

impl AsyncWrite for RotatingLog

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.