Skip to main content

Summary

Struct Summary 

Source
pub struct Summary { /* private fields */ }
Expand description

Builder for the end-of-run summary block.

Construct via the summary! macro rather than directly.

Implementations§

Source§

impl Summary

Source

pub fn new() -> Self

Create an empty summary builder.

Source

pub fn done(self, msg: &str) -> Self

Add a green DONE status line.

Source

pub fn warn(self, msg: &str) -> Self

Add a yellow WARN status line (used when there are errors).

Source

pub fn stat(self, key: &str, val: &str) -> Self

Add a key/value stat line.

Keys are right-aligned to the longest key in the same section. Values are printed as-is (may contain ANSI codes from paint).

Source

pub fn blank(self) -> Self

Add a blank line within the current section.

Source

pub fn section(self) -> Self

Start a new alignment section.

Keys in different sections are aligned independently, so a long key in the stats block doesn’t push the files block out of alignment.

Source

pub fn print(self)

Render the summary to stderr.

Trait Implementations§

Source§

impl Default for Summary

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.