Struct Report 

pub struct Report<T: Fn() -> String> { /* private fields */ }

Group of logging events

This type should not be used directly, but through the macros report and log

Implementations

impl Report<fn() -> String>

pub fn info(message: Arguments<'_>)

Logs a message with the info prefix

Example

use report::Report;

let data = 42;
Report::info(format_args!("Data: {data}"));

pub fn warn(message: Arguments<'_>)

Logs a message with the warning prefix

Example

use report::Report;

let data = 42;
Report::warn(format_args!("Warning: {data}"));

pub fn error(message: Arguments<'_>)

Logs a message with the error prefix

Example

use report::Report;

let data = 42;
Report::error(format_args!("Error: {data}"));

impl<T: Fn() -> String> Report<T>

pub fn log(message: T) -> Self

Collects all nested logging events and prints them

When this report is dropped, it will be printed to stdout.

Example

use report::{Report, info};
 
let report = Report::log(|| format!("Running task"));
info!("Complementary information");
drop(report);

pub fn rec(message: T) -> Self

Collects all nested logging events and appends them to the preceding report

When this report is dropped and there are events available, its message will be formatted, and the events will be tagged with it.

Example

use report::{Report, info};

let report = Report::rec(|| format!("Running task"));
info!("Complementary information");
drop(report);

Examples found in repository

examples/main.rs (line 10)

fn main() {
    let path = "data.txt";
    
    #[report("Running task one on {path}")]
    task_one(path).ok();

    let path = "Cargo.toml";
    #[report("Running task two on {path}")]
    task_two(path).ok();
}

fn task_one(file: &str) -> Result {
    let _file = File::open(file)?; 
    bail!("File exists, even though it should not")
}

#[report]
fn task_two(file: &str) -> Result {
    let file = File::open(file)?;
    let metadata = file.metadata()?;

    info!("File size: {}", metadata.len());
    
    for line in BufReader::new(file).lines() {
        #[report("Reading line")]
        let line = line?;

        if line.starts_with("[") {
            info!("Found section: {line}");
        }
    }

    Ok(())
}

Trait Implementations

impl<T: Fn() -> String> Drop for Report<T>

fn drop(&mut self)

Executes the destructor for this type.