Struct conserve::report::Report

pub struct Report { /* private fields */ }

A Report is notified of problems or non-problematic events that occur while Conserve is running.

A Report holds counters, identified by a name. The name must be in KNOWN_COUNTERS.

A Report is internally mutable, so a single instance can be shared by multiple objects or scopes (on the same thread) who all append to it.

Cloning a Report makes a shared reference to the same underlying counters.

Implementations

impl Report

pub fn new() -> Report

Default constructor with plain text UI.

pub fn with_ui(ui_box: Box<dyn UI + Send>) -> Report

Make a new report viewed by a given UI.

pub fn set_print_filenames(&mut self, p: bool)

pub fn borrow_counts(&self) -> MutexGuard<'_, Counts>

Borrow (read-only) counters inside this report.

pub fn increment(&self, counter_name: &'static str, delta: u64)

Increment a counter by a given amount.

The name must be a static string. Counters implicitly start at 0.

pub fn increment_size(&self, counter_name: &str, sizes: Sizes)

pub fn merge_from(&self, from_report: &Report)

Merge the contents of from_report into self.

pub fn get_size(&self, counter_name: &str) -> Sizes

pub fn get_count(&self, counter_name: &str) -> u64

pub fn start_entry(&self, entry: &dyn Entry)

Report that processing started for a given entry.

pub fn set_phase<S: Into<String>>(&self, phase: S)

Briefly describe the phase of work.

pub fn clear_phase(&self)

pub fn print(&self, s: &str)

pub fn problem(&self, s: &str)

Report that a problem occurred.

Later this might also count or summarize them.

pub fn finish(&self)

pub fn set_total_work(&self, w: u64)

Set the total expected work (in bytes); this also resets the amount of work done.

pub fn increment_work(&self, w: u64)

Trait Implementations

impl Clone for Report

fn clone(&self) -> Report

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl Default for Report

fn default() -> Self

Returns the “default value” for a type.

impl Display for Report

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

Formats the value using the given formatter.