Struct rtrtr::log::LogConfig

pub struct LogConfig {
    pub log_target: LogTarget,
    pub log_file: ConfigPath,
    pub log_facility: LogFacility,
    pub log_level: LogFilter,
}

Logging configuration.

Fields

log_target: LogTarget

Where to log to?

log_file: ConfigPath

If logging to a file, use this file.

This isn’t part of log_target for deserialization reasons.

log_facility: LogFacility

The syslog facility when logging to syslog.

This isn’t part of log_target for deserialization reasons.

log_level: LogFilter

The minimum log level to actually log.

Implementations

impl LogConfig

pub fn config_args(app: Command<'_>) -> Command<'_>

Configures a clap app with the options for logging.

pub fn update_with_arg_matches(
    &mut self,
    matches: &ArgMatches,
    cur_dir: &Path
) -> Result<(), Failed>

Update the logging configuration from command line arguments.

This should be called after the configuration file has been loaded.

pub fn init_logging() -> Result<(), ExitError>

Initialize logging.

All diagnostic output of RTRTR is done via logging, never to stderr directly. Thus, it is important to initalize logging before doing anything else that may result in such output. This function does exactly that. It sets a maximum log level of warn, leading only printing important information, and directs all logging to stderr.

pub fn switch_logging(&self, daemon: bool) -> Result<(), Failed>

Switches logging to the configured target.

Once the configuration has been successfully loaded, logging should be switched to whatever the user asked for via this method.

Trait Implementations

impl<'de> Deserialize<'de> for LogConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.