Struct slog_term::FullFormatBuilder

pub struct FullFormatBuilder<D> where
    D: Decorator,  { /* private fields */ }

Streamer builder

Implementations

impl<D> FullFormatBuilder<D> where
    D: Decorator, 

pub fn use_utc_timestamp(self) -> Self

Use the UTC time zone for the timestamp

pub fn use_local_timestamp(self) -> Self

Use the local time zone for the timestamp (default)

pub fn use_custom_timestamp<F>(self, f: F) -> Self where
    F: ThreadSafeTimestampFn, 

Provide a custom function to generate the timestamp

pub fn use_file_location(self) -> Self

Enable the file location in log in this format [file:line:column]

pub fn use_original_order(self) -> Self

Use the original ordering of key-value pairs

By default, key-values are printed in a reversed order. This option will change it to the order in which key-values were added.

pub fn use_custom_header_print<F>(self, f: F) -> Self where
    F: ThreadSafeHeaderFn, 

Provide a function that print the header

If not used, slog_term::print_msg_header will be used.

The header is the part before the log message and key-values. It usually contains the time, the log level.

The default function:

pub fn print_msg_header(
    fn_timestamp: &dyn ThreadSafeTimestampFn<Output = io::Result<()>>,
    mut rd: &mut dyn RecordDecorator,
    record: &Record,
    use_file_location: bool,
) -> io::Result<bool> {
    rd.start_timestamp()?;
    fn_timestamp(&mut rd)?;

    rd.start_whitespace()?;
    write!(rd, " ")?;

    rd.start_level()?;
    write!(rd, "{}", record.level().as_short_str())?;

    if use_file_location {
        rd.start_location()?;
        write!(
            rd,
            "[{}:{}:{}]",
            record.location().file,
            record.location().line,
            record.location().column
        )?;
    }

    rd.start_whitespace()?;
    write!(rd, " ")?;

    rd.start_msg()?;
    let mut count_rd = CountingWriter::new(&mut rd);
    write!(count_rd, "{}", record.msg())?;
    Ok(count_rd.count() != 0)
}

produces this output:

Oct 19 09:20:37.962 INFO an event log, my_key: my_value

the Oct 19 09:20:37.962 INFO part is the header.

pub fn build(self) -> FullFormat<D>

Build FullFormat