Struct FileLoggerConfig

#[non_exhaustive]
pub struct FileLoggerConfig {

    pub level: Severity,
    pub format: Format,
    pub source_location: SourceLocation,
    pub timezone: TimeZone,
    pub timestamp_template: String,
    pub path: PathBuf,
    pub channel_size: usize,
    pub truncate: bool,
    pub rotate_size: u64,
    pub rotate_keep: usize,
    pub rotate_compress: bool,
    pub overflow_strategy: OverflowStrategy,
    pub restrict_permissions: bool,
}

The configuration of FileLoggerBuilder.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

level: Severity

Log level.

format: Format

Log record format.

source_location: SourceLocation

Source code location

timezone: TimeZone

Time Zone.

timestamp_template: String

Format string for the timestamp in the path. The string is formatted using strftime

Default: “%Y%m%d_%H%M”, example: “20180918_1127”

path: PathBuf

Log file path template.

It will be used as-is, with the following transformation:

All occurrences of the substring “{timestamp}” will be replaced with the current timestamp formatted according to timestamp_template. The timestamp will respect the timezone setting.

channel_size: usize

Asynchronous channel size

truncate: bool

Truncate the file or not

rotate_size: u64

Log file rotation size.

For details, see the documentation of rotate_size.

rotate_keep: usize

Maximum number of rotated log files to keep.

For details, see the documentation of rotate_keep.

rotate_compress: bool

Whether to compress or not compress rotated files.

For details, see the documentation of rotate_compress.

The default value is false.

overflow_strategy: OverflowStrategy

Whether to drop logs on overflow.

The possible values are drop, drop_and_report, or block.

The default value is drop_and_report.

restrict_permissions: bool

Whether to restrict the permissions of log files.

For details, see the documentation of [restict_permissions].

Implementations

impl FileLoggerConfig

pub fn new() -> Self

Creates a new FileLoggerConfig with default settings.

Trait Implementations

impl Clone for FileLoggerConfig

fn clone(&self) -> FileLoggerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for FileLoggerConfig

type Builder = FileLoggerBuilder

Logger builder.

fn try_to_builder(&self) -> Result<Self::Builder>

Makes a logger builder associated with this configuration.

fn build_logger(&self) -> Result<Logger>

Builds a logger with this configuration.

impl Debug for FileLoggerConfig

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

Formats the value using the given formatter.

impl Default for FileLoggerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileLoggerConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FileLoggerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.