Crate r3bl_simple_logger

How to log things, and simply use the logging facilities

The simplest way to use this crate is to look at the r3bl_rs_utils_core::try_to_set_log_level function in the r3bl_rs_utils_core crate as the main entry point. By default, logging is disabled even if you call all the functions in the file_logger module in that crate: log_debug, log_info, log_trace, etc.

How to change how logging is implemented under the hood

Under the hood the simplelog crate is forked and modified for use here. The following are details for people who want to work on changing the underlying behavior of the logging engine itself, and not for folks who just want to use this crate.

r3bl_simple_logger provides a series of logging facilities, that can be easily combined.

• SimpleLogger (very basic logger that logs to stdout)
• TermLogger (advanced terminal logger, that splits to stdout/err and has color support) (can be excluded on unsupported platforms)
• WriteLogger (logs to a given struct implementing Write, e.g. a file)
• CombinedLogger (can be used to form combinations of the above loggers)
• TestLogger (specialized logger for tests. Uses print!() / println!() for tests to be able to capture the output)

Only one Logger should be initialized of the start of your program through the Logger::init(...) method. For the actual calling syntax take a look at the documentation of the specific implementation(s) you wanna use.

Macros

• debug
  Logs a message at the debug level.
• error
  Logs a message at the error level.
• format_description
• info
  Logs a message at the info level.
• log
  The standard logging macro.
• log_enabled
  Determines if a message logged at the specified level in that module will be logged.
• trace
  Logs a message at the trace level.
• warn
  Logs a message at the warn level.

Structs

• CombinedLogger
  The CombinedLogger struct. Provides a Logger implementation that proxies multiple Loggers as one.
• Config
  Configuration for the Loggers
• ConfigBuilder
  Builder for the Logger Configurations (Config)
• Metadata
  Metadata about a log message.
• MetadataBuilder
  Builder for Metadata.
• ParseLevelError
  The type returned by from_str when the string doesn’t match any of the log levels.
• Record
  The “payload” of a log message.
• RecordBuilder
  Builder for Record.
• SetLoggerError
  The type returned by set_logger if set_logger has already been called.
• SimpleLogger
  The SimpleLogger struct. Provides a very basic Logger implementation
• TermLogger
  The TermLogger struct. Provides a stderr/out based Logger implementation
• TestLogger
  The TestLogger struct. Provides a very basic Logger implementation that may be captured by cargo.
• WriteLogger
  The WriteLogger struct. Provides a Logger implementation for structs implementing Write, e.g. File

Enums

• Color
  The set of available colors for the terminal foreground/background.
• ColorChoice
  ColorChoice represents the color preferences of an end user.
• FormatItem
  A complete description of how to format and parse a type.
• Level
  An enum representing the available verbosity levels of the logger.
• LevelFilter
  An enum representing the available verbosity level filters of the logger.
• LevelPadding
  Padding to be used for logging the level
• TargetPadding
  Padding to be used for logging the thread id/name
• TerminalMode
  Specifies which streams should be used when logging
• ThreadLogMode
  Mode for logging the thread name or id or both.
• ThreadPadding
  Padding to be used for logging the thread id/name

Constants

• STATIC_MAX_LEVEL
  The statically resolved maximum log level.

Traits

• Log
  A trait encapsulating the operations required of a logger.
• SharedLogger
  Trait to have a common interface to obtain the Level of Loggers

Functions

• logger
  Returns a reference to the logger.
• max_level
  Returns the current maximum log level.
• set_boxed_logger
  Sets the global logger to a Box<Log>.
• set_logger
  Sets the global logger to a &'static Log.
• set_logger_racy^⚠
  A thread-unsafe version of set_logger.
• set_max_level
  Sets the global maximum log level.
• set_max_level_racy^⚠
  A thread-unsafe version of set_max_level.