Struct Glog

pub struct Glog { /* private fields */ }

The logging structure doing all the heavy lifting

Implementations

impl Glog

pub fn new() -> Glog

Create a new Glog object for logging

pub fn init(&mut self, flags: Flags) -> Result<(), SetLoggerError>

Initialize the logging object and register it with the standard logging frontend

Example

use log::*;
use glog::Flags;

glog::new().init(Flags::default()).unwrap();

info!("A log message");

Examples found in repository

examples/main.rs (lines 28-34)

fn main() {
    glog::new()
        .with_year(true)
        .reduced_log_levels(true)
        .set_application_fingerprint("Example")
        .init(Flags {
            colorlogtostderr: true,
            minloglevel: Level::Trace,
            log_backtrace_at: Some("main.rs:20".to_owned()),
            alsologtostderr: true,
            ..Default::default()
        })
        .unwrap();

    error!("some erro in main while testing the logger");

    foo();

    info!(
        "{:?}",
        Flags {
            ..Default::default()
        }
    );
}

pub fn with_year(self, with_year: bool) -> Self

Enable the year in the log timestamp

By default the year is not part of the timestamp.

Examples

use log::*;
use glog::Flags;

// init of glog happens here in examples

info!("A log message");

With year

glog::new().with_year(true).init(Flags::default()).unwrap();
// Will log:
// I20210401 12:34:56.987654   123 doc.rs:4] A log message

Without year

glog::new().with_year(false).init(Flags::default()).unwrap();
// Will log:
// I0401 12:34:56.987654   123 doc.rs:4] A log message

Examples found in repository

examples/main.rs (line 25)

fn main() {
    glog::new()
        .with_year(true)
        .reduced_log_levels(true)
        .set_application_fingerprint("Example")
        .init(Flags {
            colorlogtostderr: true,
            minloglevel: Level::Trace,
            log_backtrace_at: Some("main.rs:20".to_owned()),
            alsologtostderr: true,
            ..Default::default()
        })
        .unwrap();

    error!("some erro in main while testing the logger");

    foo();

    info!(
        "{:?}",
        Flags {
            ..Default::default()
        }
    );
}

pub fn reduced_log_levels(self, limit_abbreviations: bool) -> Self

Change the behavior regarding Trace and Debug levels

If limit_abbreviations is set to false Trace and Debug get their own levels. Otherwise they will be logged in the Info level.

By default reduced_log_levels is true.

Examples

use log::*;
use glog::Flags;

// glog init happens here

trace!("A trace message");
debug!("Helpful for debugging");
info!("An informational message");

With all abbreviations

glog::new()
    .reduced_log_levels(false) // Treat DEBUG and TRACE as separate levels
    .init(Flags {
        minloglevel: Level::Trace, // By default glog will only log INFO and more severe
        logtostderr: true, // don't write to log files
        ..Default::default()
    }).unwrap();

// T0401 12:34:56.000000  1234 doc.rs:12] A trace message
// D0401 12:34:56.000050  1234 doc.rs:13] Helpful for debugging
// I0401 12:34:56.000100  1234 doc.rs:14] An informational message

With limited abbreviations

glog::new()
    .reduced_log_levels(true) // Treat DEBUG and TRACE are now logged as INFO
    .init(Flags {
        minloglevel: Level::Trace, // By default glog will only log INFO and more severe
        logtostderr: true, // don't write to log files
        ..Default::default()
    }).unwrap();

// I0401 12:34:56.000000  1234 doc.rs:12] A trace message
// I0401 12:34:56.000050  1234 doc.rs:13] Helpful for debugging
// I0401 12:34:56.000100  1234 doc.rs:14] An informational message

Examples found in repository

examples/main.rs (line 26)

fn main() {
    glog::new()
        .with_year(true)
        .reduced_log_levels(true)
        .set_application_fingerprint("Example")
        .init(Flags {
            colorlogtostderr: true,
            minloglevel: Level::Trace,
            log_backtrace_at: Some("main.rs:20".to_owned()),
            alsologtostderr: true,
            ..Default::default()
        })
        .unwrap();

    error!("some erro in main while testing the logger");

    foo();

    info!(
        "{:?}",
        Flags {
            ..Default::default()
        }
    );
}

pub fn set_application_fingerprint(self, fingerprint: &str) -> Self

Set fingerprint as the application fingerprint in the log file header

Examples found in repository

examples/main.rs (line 27)

fn main() {
    glog::new()
        .with_year(true)
        .reduced_log_levels(true)
        .set_application_fingerprint("Example")
        .init(Flags {
            colorlogtostderr: true,
            minloglevel: Level::Trace,
            log_backtrace_at: Some("main.rs:20".to_owned()),
            alsologtostderr: true,
            ..Default::default()
        })
        .unwrap();

    error!("some erro in main while testing the logger");

    foo();

    info!(
        "{:?}",
        Flags {
            ..Default::default()
        }
    );
}

Trait Implementations

impl Clone for Glog

fn clone(&self) -> Glog

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Glog

fn default() -> Self

Returns the “default value” for a type.

impl Log for Glog

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.