Struct holochain_logging::FastLoggerBuilder

pub struct FastLoggerBuilder { /* fields omitted */ }

Logger Builder used to correctly set up our logging capability.

Methods

impl<'a> FastLoggerBuilder

use holochain_logging::FastLoggerBuilder;

let logger = FastLoggerBuilder::new()
    .set_level_from_str("Debug")
    .set_channel_size(512)
    .build();

assert!(logger.is_ok());

pub fn new() -> Self

It will init a FastLogger with the default argument (log level set to Info by default).

pub fn from_toml(toml_str: &str) -> Result<Self, Error>

Instantiate a logger builder from a config file in TOML format.

use holochain_logging::FastLoggerBuilder;

let toml = r#"
[logger]
level = "debug"
    [[logger.rules]]
    pattern = ".*"
    color = "red"
"#;

let logger = FastLoggerBuilder::from_toml(toml)
                .expect("Fail to instantiate the logger from toml.");
assert!(logger.build().is_ok());

pub fn level(&self) -> Level

Returns the verbosity level of logger to build. Can be one of: Trace, Debug, Info, Warn or Error.

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

Set the verbosity level of the logger. Value can be one of: Trace, Debug, Info, Warn or Error.

pub fn set_level_from_str(&mut self, level: &str) -> &mut Self

Set the verbosity level of the logger from a string value: Trace, Debug, Info, Warn or Error.

pub fn set_channel_size(&mut self, channel_size: usize) -> &mut Self

Sets the capacity of our bounded message queue (i.e. there is a limit to how many messages it can hold at a time.). By default we use a queue of 1024.

pub fn timestamp_format(&mut self, timestamp_fmt: &str) -> &mut Self

Customize our logging timestamp.

pub fn add_rule_filter(&mut self, rule_filter: RuleFilter) -> &mut Self

Add filtering rules to the logging facility.

pub fn rule_filters(&self) -> &[RuleFilter]

Returns all the rules that will be applied to the logger.

pub fn redirect_to_file(&mut self, file_path: &str) -> &mut Self

Redirect log message to the provided file path.

pub fn file_path(&self) -> Option<String>

Returns the file path of the logs in the case we want to redirect them to a file.

pub fn build(&self) -> Result<FastLogger, SetLoggerError>

Registers a FastLogger as the comsumer of log facade so it becomes static and any further mutation are discarded.

pub fn build_test(&self) -> Result<FastLogger, SetLoggerError>

Dull log build, only used for test purposes because it actually doesn't log anything by not registering the logger.

Trait Implementations

impl Default for FastLoggerBuilder

fn default() -> Self

Returns the "default value" for a type.