Struct TreeLogger 

pub struct TreeLogger { /* private fields */ }

Implementations

impl TreeLogger

pub fn new() -> TreeLogger

Initializes the global logger with a CustomLogger instance with default log level set to Level::Trace.

use tree_logger::TreeLogger;
TreeLogger::new().with_colors(true).with_threads(true).init().unwrap();
log::warn!("This is an example message.");

Examples found in repository

examples/demo.rs (line 6)

fn main() {
    TreeLogger::new()
        .with_colors(true)
        .with_threads(true)
        .with_filter_fn(|data| {
            match data.elapsed {
                // Filter out very quick events
                Some(elapsed) => elapsed > 5,
                None => true,
            }
        })
        .init()
        .unwrap();

    profile!("Super quick event, will be filtered out", || {
        info!("Can't see me");
        info!("Can't see me");
        info!("Can't see me");
    });

    warn!("Basic warning, not nested, shows up immediately");
    let result = profile!("First span", || {
        info!("Info inside a span. Doesn't print until the whole span is done");

        thread::sleep(Duration::from_secs(2));

        profile!("Child span #1", || {
            info!("Info inside a child span #1");
            thread::sleep(Duration::from_secs(1));
        });

        profile!("Child span #2", || {
            info!("Info inside a child span #2");
            thread::sleep(Duration::from_secs(1));
        });

        42 // Optionally we can return a value
    });

    info!("Profile returns a value: {result}");
}

pub fn init(self) -> Result<(), SetLoggerError>

Examples found in repository

examples/demo.rs (line 16)

fn main() {
    TreeLogger::new()
        .with_colors(true)
        .with_threads(true)
        .with_filter_fn(|data| {
            match data.elapsed {
                // Filter out very quick events
                Some(elapsed) => elapsed > 5,
                None => true,
            }
        })
        .init()
        .unwrap();

    profile!("Super quick event, will be filtered out", || {
        info!("Can't see me");
        info!("Can't see me");
        info!("Can't see me");
    });

    warn!("Basic warning, not nested, shows up immediately");
    let result = profile!("First span", || {
        info!("Info inside a span. Doesn't print until the whole span is done");

        thread::sleep(Duration::from_secs(2));

        profile!("Child span #1", || {
            info!("Info inside a child span #1");
            thread::sleep(Duration::from_secs(1));
        });

        profile!("Child span #2", || {
            info!("Info inside a child span #2");
            thread::sleep(Duration::from_secs(1));
        });

        42 // Optionally we can return a value
    });

    info!("Profile returns a value: {result}");
}

pub fn with_filter_fn(self, filter_fn: fn(&LoggingEvent) -> bool) -> TreeLogger

Examples found in repository

examples/demo.rs (lines 9-15)

fn main() {
    TreeLogger::new()
        .with_colors(true)
        .with_threads(true)
        .with_filter_fn(|data| {
            match data.elapsed {
                // Filter out very quick events
                Some(elapsed) => elapsed > 5,
                None => true,
            }
        })
        .init()
        .unwrap();

    profile!("Super quick event, will be filtered out", || {
        info!("Can't see me");
        info!("Can't see me");
        info!("Can't see me");
    });

    warn!("Basic warning, not nested, shows up immediately");
    let result = profile!("First span", || {
        info!("Info inside a span. Doesn't print until the whole span is done");

        thread::sleep(Duration::from_secs(2));

        profile!("Child span #1", || {
            info!("Info inside a child span #1");
            thread::sleep(Duration::from_secs(1));
        });

        profile!("Child span #2", || {
            info!("Info inside a child span #2");
            thread::sleep(Duration::from_secs(1));
        });

        42 // Optionally we can return a value
    });

    info!("Profile returns a value: {result}");
}

pub fn with_level(self, level: LevelFilter) -> TreeLogger

pub fn with_threads(self, enable_threads: bool) -> TreeLogger

Examples found in repository

examples/demo.rs (line 8)

fn main() {
    TreeLogger::new()
        .with_colors(true)
        .with_threads(true)
        .with_filter_fn(|data| {
            match data.elapsed {
                // Filter out very quick events
                Some(elapsed) => elapsed > 5,
                None => true,
            }
        })
        .init()
        .unwrap();

    profile!("Super quick event, will be filtered out", || {
        info!("Can't see me");
        info!("Can't see me");
        info!("Can't see me");
    });

    warn!("Basic warning, not nested, shows up immediately");
    let result = profile!("First span", || {
        info!("Info inside a span. Doesn't print until the whole span is done");

        thread::sleep(Duration::from_secs(2));

        profile!("Child span #1", || {
            info!("Info inside a child span #1");
            thread::sleep(Duration::from_secs(1));
        });

        profile!("Child span #2", || {
            info!("Info inside a child span #2");
            thread::sleep(Duration::from_secs(1));
        });

        42 // Optionally we can return a value
    });

    info!("Profile returns a value: {result}");
}

pub fn with_colors(self, enable_colors: bool) -> TreeLogger

Control whether messages are colored or not.

Examples found in repository

examples/demo.rs (line 7)

fn main() {
    TreeLogger::new()
        .with_colors(true)
        .with_threads(true)
        .with_filter_fn(|data| {
            match data.elapsed {
                // Filter out very quick events
                Some(elapsed) => elapsed > 5,
                None => true,
            }
        })
        .init()
        .unwrap();

    profile!("Super quick event, will be filtered out", || {
        info!("Can't see me");
        info!("Can't see me");
        info!("Can't see me");
    });

    warn!("Basic warning, not nested, shows up immediately");
    let result = profile!("First span", || {
        info!("Info inside a span. Doesn't print until the whole span is done");

        thread::sleep(Duration::from_secs(2));

        profile!("Child span #1", || {
            info!("Info inside a child span #1");
            thread::sleep(Duration::from_secs(1));
        });

        profile!("Child span #2", || {
            info!("Info inside a child span #2");
            thread::sleep(Duration::from_secs(1));
        });

        42 // Optionally we can return a value
    });

    info!("Profile returns a value: {result}");
}

pub fn max_level(&self) -> LevelFilter

Trait Implementations

impl Default for TreeLogger

fn default() -> Self

Returns the “default value” for a type.

impl Log for TreeLogger

fn enabled(&self, metadata: &Metadata<'_>) -> bool

Determines if a log message with the specified metadata would be logged.

fn log(&self, record: &Record<'_>)

Logs the Record.

fn flush(&self)

Flushes any buffered records.