Struct session_log::Logger

pub struct Logger(/* private fields */);

Implementations

impl Logger

pub fn with_options( name: impl Into<String>, level: Level, directory: impl Into<String> ) -> Result<Logger, ErrorKind>

Create a new logging entry with the given name & options.
OR
Retrieve an existing logging entry if the entry already exists and have same options.

Parameters

• name - The name of the logging entry.
• level - The level of the logging entry.
• directory - The directory where the log files will be stored. (Relative to the current working directory)

Errors

• ErrorKind::DifferentLevel if the existing logger has different level than the given options.
• ErrorKind::DifferentDirectory if the existing logger has different directory than the given options.
• ErrorKind::FailedToCreateFolder if the directory cannot be created.

Examples

use session_log::{Logger, Level};

fn main() {
  let logger = Logger::with_options(
    "main", Level::Debug, "logs/main");

  let logger2 = Logger::with_options(
    "main", Level::Debug, "logs/main");  // Retrieve the existing logger

  let logger3 = Logger::with_options(
    "main", Level::Info , "logs/main");  // Error: Different level

  let logger4 = Logger::with_options(
    "main", Level::Debug, "logs/other"); // Error: Different directory
}

pub fn try_with_option( name: impl Into<String>, level: Level, directory: impl Into<String> ) -> Logger

Create a new logging entry with the given name & options.
OR
Retrieve an existing logging entry if the entry already exists.

Unlike Logger::with_options, this method doesn’t return an error if the existing logger has different options. Instead, it will just ignore the given options and return the existing logger.

Parameters

• name - The name of the logging entry.
• level - The level of the logging entry.
• directory - The directory where the log files will be stored. (Relative to the current working directory)

Examples

use session_log::{Logger, Level};

fn main() {
  let logger = Logger::try_with_option(
    "main", Level::Debug, "logs/main");

  let logger2 = Logger::try_with_option(
    "main", Level::Debug, "logs/main");  // Retrieve the existing logger

  let logger3 = Logger::try_with_option(
    "main", Level::Info , "logs/main");  // Retrieve the existing logger

  let logger4 = Logger::try_with_option(
    "main", Level::Debug, "logs/other"); // Retrieve the existing logger
}

pub fn new(name: impl Into<String>) -> Logger

Create a new logging entry with the given name. Level and directory is defaulted to Info and “logs”
OR
Retrieve an existing logging entry if the entry already exists.

Unlike Logger::with_options, this method doesn’t return an error if the existing logger has different options. Instead, it will just ignore the given options and return the existing logger.

Parameters

• name - The name of the logging entry.

Examples

use session_log::Logger;

fn main() {
  let logger  = Logger::new("main");
  let logger2 = Logger::new("main"); // Retrieve the existing logger
}

pub fn get_level(&self) -> Level

Get logging level for this entry.

Examples

use session_log::{Logger, Level};

fn main() {
  let logger = Logger::new("main");

  assert_eq!(logger.get_level(), Level::Info);
}

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

Set logging level for this entry

Examples

use session_log::{Logger, Level};

fn main() {
  let mut logger = Logger::new("main");

  logger.set_level(Level::Debug);
  assert_eq!(logger.get_level(), Level::Debug);

  logger.set_level(Level::Info);
  assert_eq!(logger.get_level(), Level::Info);
}

pub fn get_directory(&self) -> String

Get logging directory for this entry.

Examples

use session_log::Logger;

fn main() {
  let logger = Logger::new("main");

  assert_eq!(logger.get_directory(), "logs");
}

pub fn set_directory(&mut self, directory: impl Into<String>) -> Result<()>

Set logging directory for this entry and create the directory if it doesn’t exist. the result of creating the directory is returned.

Examples

use session_log::Logger;

fn main() {
  let mut logger = Logger::new("main");

  logger.set_directory("logs/main");
  assert_eq!(logger.get_directory(), "logs/main");

  logger.set_directory("logs/other");
  assert_eq!(logger.get_directory(), "logs/other");
}

pub fn session(&self, name: &str) -> Session

Create a new session with the given name under this logging entry.

Trait Implementations

impl Clone for Logger

fn clone(&self) -> Logger

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Logger

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Loggable for Logger

fn log(&self, level: Level, message: &str)

Log a message with the dynamic level.

fn debug(&self, message: &str)

Log a message at the debug level with caller position.

fn verbose(&self, message: &str)

Log a message at the verbose level with caller position.

fn info(&self, message: &str)

Log a message at the info level with caller position.

fn warning(&self, message: &str)

Log a message at the warning level with caller position.

fn critical(&self, message: &str)

Log a message at the critical level with caller position.

fn error(&self, message: &str)

Log a message at the error level with caller position.

fn fatal(&self, message: &str) -> !

Log a message at the fatal level with caller position then panic.