Struct Log 

pub struct Log {
    pub channel: String,
    pub level: LogLevel,
    pub message: String,
}

Represents a log entry. Log beautifully implements Display for easy printing.

use breadcrumbs::Log;
let log = Log::new(String::from("test_channel"), breadcrumbs::LogLevel::Info, String::from("Test log message"));
assert_eq!(format!("{}", log), "[test_channel/Info] Test log message");

Fields

channel: String

level: LogLevel

message: String

Implementations

impl Log

pub fn new(channel: String, level: LogLevel, message: String) -> Log

Creates a new log entry.

pub fn remove(&self)

Removes the log from the stored traceback of logs. This log will not use up memory or be printed by the traceback macros. Useful in embedded systems where memory is limited.

Example Usecase

use breadcrumbs::{LogListener, Log};
 
struct MyLogListener;
impl LogListener for MyLogListener {
    fn on_log(&mut self, log: Log) {
        if !log.level.is_at_least(breadcrumbs::LogLevel::Warn) {
            log.remove();
        }
    }
}

Trait Implementations

impl Clone for Log

fn clone(&self) -> Log

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Log

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

Formats the value using the given formatter.

impl Display for Log

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

Formats the value using the given formatter.

impl Ord for Log

fn cmp(&self, other: &Log) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Log

fn eq(&self, other: &Log) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Log

fn partial_cmp(&self, other: &Log) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Log

impl StructuralPartialEq for Log