Struct ChildMonitor

pub struct ChildMonitor<'n, 'p, W: Work, P: ProgressMonitor<W>> { /* private fields */ }

A child monitor references a parent monitor. It monitors a subset of it’s parent’s total work, named parent_work. This monitors own scale is declared by sub_work and can be arbitrary. A child monitor, as a main monitor, tracks its progress. See sub_work_completed. Whenever work is being made in a child monitor, the parents progress is increased relative amount.

Example: Given a ChildMonitor with

• parent_work == 10
• sub_work == 1000 When a work(500) is submitted Then the parent.work(5) is submitted.

Implementations

impl<'n, 'p, W: Work, P: ProgressMonitor<W>> ChildMonitor<'n, 'p, W, P>

pub fn new( name: Cow<'n, str>, parent: &'p mut P, parent_work: W, sub_work: W, ) -> Self

pub fn name(&self) -> Cow<'n, str>

Trait Implementations

impl<'n, 'p, W: Debug + Work, P: Debug + ProgressMonitor<W>> Debug for ChildMonitor<'n, 'p, W, P>

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

Formats the value using the given formatter.

impl<'n, 'p, W: Work, T: ProgressMonitor<W>> Display for ChildMonitor<'n, 'p, W, T>

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

Formats the value using the given formatter.

impl<'n, 'p, W: Work, T: ProgressMonitor<W>> Drop for ChildMonitor<'n, 'p, W, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'n, 'p, W: Work, P: ProgressMonitor<W>> ProgressMonitor<W> for ChildMonitor<'n, 'p, W, P>

fn worked<A: Into<W>>(&mut self, amount_of_work: A)

fn total(&self) -> &W

fn completed(&self) -> &W

fn remaining(&self) -> Cow<'_, W>

fn close(&mut self) -> Result<(), CloseError>

If you are done with your work, close this monitor.

impl<'p2, 'n2, 'p, 'n, N, W, A1, A2, P> ProgressMonitorDivision<'p, 'n, N, W, A1, A2> for ChildMonitor<'n2, 'p2, W, P>

where Self: ProgressMonitor<W> + Sized, N: Into<Cow<'n, str>>, W: Work, A1: Into<W>, A2: Into<W>, P: ProgressMonitor<W>,

fn new_child( &'p mut self, name: N, amount_of_parent_work: A1, amount_of_child_work: A2, ) -> ChildMonitor<'n, 'p, W, Self>