Struct FlashLogBuilder 

pub struct FlashLogBuilder { /* private fields */ }

Builder for configuring and starting the ferrilog logger.

Example

let _guard = ferrilog::builder()
    .level(ferrilog::INFO)
    .log_file("/var/log/app.log")
    .rotation(RotationConfig::by_size(100_000_000, 5))
    .flush_delay(Duration::from_secs(3))
    .flush_buffer_size(8192)
    .flush_on(ferrilog::ERR)
    .poller_interval(Duration::from_millis(1))
    .poller_core_affinity(3)
    .start()?;
// guard drop automatically stops poller and flushes

Implementations

impl FlashLogBuilder

pub fn new() -> Self

Creates a new builder with default settings.

pub fn level(self, level: Level) -> Self

Set the minimum log level.

pub fn flush_delay(self, delay: Duration) -> Self

Set the flush delay duration.

pub fn flush_buffer_size(self, bytes: u32) -> Self

Set the flush buffer size in bytes.

pub fn flush_on(self, level: Level) -> Self

Set the level at or above which an immediate flush is triggered.

pub fn queue_full_policy(self, policy: QueueFullPolicy) -> Self

Set the queue-full policy.

pub fn queue_full_callback(self, callback: QueueFullCallback) -> Self

Set the queue-full callback.

pub fn log_file(self, path: impl Into<String>) -> Self

Set the log output file path.

pub fn rotation(self, config: RotationConfig) -> Self

Set the log file rotation config. Requires log_file to be set.

pub fn header_pattern(self, pattern: impl Into<String>) -> Self

Set a custom header pattern string.

pub fn poller_interval(self, interval: Duration) -> Self

Set the poller thread interval.

pub fn poller_core_affinity(self, core_id: usize) -> Self

Pin the poller thread to the given CPU core (Linux only; ignored on other platforms).

pub fn start(self) -> Result<FlashLogGuard>

Apply all configuration and start the background polling thread.

Returns a FlashLogGuard that stops the poller and flushes when dropped.

Trait Implementations

impl Default for FlashLogBuilder

fn default() -> Self

Returns the “default value” for a type.