Struct argmin::core::observers::slog_logger::SlogLogger

pub struct SlogLogger { /* private fields */ }

A logger using the slog crate as backend.

Implementations

impl SlogLogger

pub fn term() -> Self

Log to the terminal.

Will block execution when buffer is full.

Example

use argmin::core::observers::SlogLogger;

let terminal_logger = SlogLogger::term();

pub fn term_noblock() -> Self

Log to the terminal without blocking execution.

Messages may be lost in case of buffer overflow.

Example

use argmin::core::observers::SlogLogger;

let terminal_logger = SlogLogger::term_noblock();

pub fn file<N: AsRef<str>>(file: N, truncate: bool) -> Result<Self, Error>

Log JSON to a file while blocking execution in case of full buffers.

If truncate is set to true, the content of existing log files will be cleared.

Only available if the serde1 feature is set.

Example

use argmin::core::observers::SlogLogger;

let file_logger = SlogLogger::file("logfile.log", true);

pub fn file_noblock<N: AsRef<str>>(
    file: N,
    truncate: bool
) -> Result<Self, Error>

Log JSON to a file without blocking execution.

Messages may be lost in case of buffer overflow.

If truncate is set to true, the content of existing log files will be cleared.

Only available if the serde1 feature is set.

Example

use argmin::core::observers::SlogLogger;

let file_logger = SlogLogger::file_noblock("logfile.log", true);

Trait Implementations

impl Clone for SlogLogger

fn clone(&self) -> SlogLogger

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Observe<I> for SlogLogger where
    I: State, 

fn observe_init(&mut self, msg: &str, kv: &KV) -> Result<(), Error>

Log basic information about the optimization after initialization.

fn observe_iter(&mut self, state: &I, kv: &KV) -> Result<(), Error>

Logs information about the progress of the optimization after every iteration.