Crate axlog

source ·
Expand description

Macros for multi-level formatted logging used by ArceOS.

The log macros, in descending order of level, are: error!, warn!, info!, debug!, and trace!.

If it is used in no_std environment, the users need to implement the LogIf to provide external functions such as console output.

To use in the std environment, please enable the std feature:

[dependencies]
axlog = { version = "0.1", features = ["std"] }

Cargo features:

  • std: Use in the std environment. If it is enabled, you can use console output without implementing the LogIf trait. This is disabled by default.
  • log-level-off: Disable all logging. If it is enabled, all log macros (e.g. info!) will be optimized out to a no-op in compilation time.
  • log-level-error: Set the maximum log level to error. Any macro with a level lower than error! (e.g, warn!, info!, …) will be optimized out to a no-op.
  • log-level-warn, log-level-info, log-level-debug, log-level-trace: Similar to log-level-error.

Examples

use axlog::{debug, error, info, trace, warn};

// Initialize the logger.
axlog::init();
// Set the maximum log level to `info`.
axlog::set_max_level("info");

// The following logs will be printed.
error!("error");
warn!("warn");
info!("info");

// The following logs will not be printed.
debug!("debug");
trace!("trace");

Macros

  • ax_print
    Prints to the console.
  • ax_println
    Prints to the console, with a newline.
  • debug
    Logs a message at the debug level.
  • error
    Logs a message at the error level.
  • info
    Logs a message at the info level.
  • trace
    Logs a message at the trace level.
  • warn
    Logs a message at the warn level.

Traits

  • LogIf
    Extern interfaces that must be implemented in other crates.

Functions