Struct origen::LOGGER

pub struct LOGGER { /* fields omitted */ }

Methods from Deref<Target = Logger>

pub fn verbosity(&self) -> u8

pub fn set_verbosity(&self, level: u8) -> Result<()>

pub fn set_verbosity_keywords(&self, keywords: Vec<String>) -> Result<()>

pub fn keywords_to_cmd(&self) -> String

pub fn has_keyword(&self, keyword: &str) -> bool

pub fn set_status_ready(&self)

This is called automatically by Origen during the boot process to inform when the logger can start looking for a log file to use

pub fn display(&self, message: &str)

This is the same as calling ‘print!’ but with it also being captured to the log. Use for displaying output to the terminal when creating CLI tools. The given message will always be output to the console and without a timestamp. It will also appear in the log file with a timestamp.

pub fn displayln(&self, message: &str)

Like display!, but appends a newline, this is like calling println! but it also appears in the log.

pub fn display_green(&self, message: &str)

See display

pub fn display_greenln(&self, message: &str)

See displayln

pub fn display_yellow(&self, message: &str)

See display

pub fn display_yellowln(&self, message: &str)

See displayln

pub fn display_cyan(&self, message: &str)

See display

pub fn display_cyanln(&self, message: &str)

See displayln

pub fn display_red(&self, message: &str)

See display

pub fn display_redln(&self, message: &str)

See displayln

pub fn display_block(&self, messages: &Vec<&str>)

See display

pub fn debug(&self, message: &str)

Log a debug message, this will be displayed in the terminal when running with -vv

pub fn debug_block(&self, messages: &Vec<&str>)

Log a debug message, this will be displayed in the terminal when running with -vv

pub fn trace(&self, message: &str)

Log a trace (very low level) debug message, this will be displayed in the terminal when running with -vvv

pub fn trace_block(&self, messages: &Vec<&str>)

Log a trace (very low level) debug message, this will be displayed in the terminal when running with -vvv

pub fn deprecated(&self, message: &str)

Log a deprecation warning message, this will be displayed in the terminal when running with -v

pub fn deprecated_block(&self, messages: &Vec<&str>)

Log a deprecation warning message, this will be displayed in the terminal when running with -v

pub fn error(&self, message: &str)

Log an error message, this will always be displayed in the terminal

pub fn error_block(&self, messages: &Vec<&str>)

Log an error message, this will always be displayed in the terminal

pub fn info(&self, message: &str)

Log an info message, this will be displayed in the terminal when running with -v

pub fn info_block(&self, messages: &Vec<&str>)

Log an info message, this will be displayed in the terminal when running with -v

pub fn success(&self, message: &str)

Log a success message, this will be displayed in the terminal when running with -v

pub fn success_block(&self, messages: &Vec<&str>)

Log a success message, this will be displayed in the terminal when running with -v

pub fn warning(&self, message: &str)

Log a warning message, this will be displayed in the terminal when running with -v

pub fn warning_block(&self, messages: &Vec<&str>)

Log a warning message, this will be displayed in the terminal when running with -v

pub fn output_file(&self) -> PathBuf

Returns the path to the current log file

pub fn open_logfile(
    &self,
    path: Option<&Path>,
    thread_local: bool
) -> Result<PathBuf>

See with_log which is the equivalent to calling open_logfile followed by close_logfile manually.

pub fn close_logfile(&self)

pub fn with_logfile<F>(
    &self,
    path: Option<&Path>,
    thread_local: bool,
    f: F
) -> Result<PathBuf> where
    F: FnMut() -> Result<()>, 

Send all logging to the given log file for the duration of the given function, returning all logging to the previous log file at the end.

If thread_local is set to true this will apply only to the current thread.

If no path is given for the new log file (normally just the name of it), then a new logfile will be created with a unique index number appended to the current logfile name, e.g. out.log.1, out.log.2, etc.

An error will be returned if there is a problem creating the given log file, otherwise the result from the given function is returned.

Examples

use origen::LOGGER;
use std::path::Path;

let result = LOGGER.with_logfile(Some(Path::new("my_log")), false, || {
  log_debug!("This will appear in 'my_log'");
  Ok(())
});

Trait Implementations

impl Deref for LOGGER

type Target = Logger

The resulting type after dereferencing.

fn deref(&self) -> &Logger

Dereferences the value.

impl LazyStatic for LOGGER

fn initialize(lazy: &Self)