Struct prodash::tree::Item [−][src]
pub struct Item { /* fields omitted */ }
Expand description
A Tree
represents an element of the progress tree.
It can be used to set progress and send messages.
let tree = prodash::Tree::new();
let mut progress = tree.add_child("task 1");
progress.init(Some(10), Some("elements".into()));
for p in 0..10 {
progress.set(p);
}
progress.done("great success");
let mut sub_progress = progress.add_child("sub-task 1");
sub_progress.init(None, None);
sub_progress.set(5);
sub_progress.fail("couldn't finish");
Implementations
Initialize the Item for receiving progress information.
If max
is Some(…)
, it will be treated as upper bound. When progress is set(…)
it should not exceed the given maximum.
If max
is None
, the progress is unbounded. Use this if the amount of work cannot accurately
be determined.
If unit
is Some(…)
, it is used for display purposes only. It should be using the plural.
If this method is never called, this Item
will serve as organizational unit, useful to add more structure
to the progress tree.
Note that this method can be called multiple times, changing the bounded-ness and unit at will.
Set the name of this task’s progress to the given name
.
Returns the maximum about of items we expect, as provided with the init(…)
call
Set the current progress to the given step
.
Note: that this call has no effect unless init(…)
was called before.
Increment the current progress by the given step
.
Note: that this call has no effect unless init(…)
was called before.
Increment the current progress by one.
Note: that this call has no effect unless init(…)
was called before.
Call to indicate that progress cannot be indicated, and that the task cannot be interrupted.
Use this, as opposed to halted(…)
, if a non-interruptable call is about to be made without support
for any progress indication.
If eta
is Some(…)
, it specifies the time at which this task is expected to
make progress again.
The halted-state is undone next time tree::Item::running(…)
is called.
Call to indicate that progress cannot be indicated, even though the task can be interrupted.
Use this, as opposed to blocked(…)
, if an interruptable call is about to be made without support
for any progress indication.
If eta
is Some(…)
, it specifies the time at which this task is expected to
make progress again.
The halted-state is undone next time tree::Item::running(…)
is called.
Call to indicate that progress is back in running state, which should be called after the reason for
calling blocked()
or halted()
as passed.
Adds a new child Tree
, whose parent is this instance, with the given name
.
Important: The depth of the hierarchy is limited to tree::Key::max_level
.
Exceeding the level will be ignored, and new tasks will be added to this instance’s
level instead.
Create a message
of the given level
and store it with the progress tree.
Use this to provide additional,human-readable information about the progress made, including indicating success or failure.
Trait Implementations
type SubProgress = Item
type SubProgress = Item
The type of progress returned by add_child()
.
Adds a new child, whose parent is this instance, with the given name. Read more
Initialize the Item for receiving progress information. Read more
Set the current progress to the given step
. The cost of this call is negligible,
making manual throttling not necessary. Read more
Returns the maximum about of items we expect, as provided with the init(…)
call
Increment the current progress to the given step
.
The cost of this call is negligible, making manual throttling not necessary. Read more
Set the name of the instance, altering the value given when crating it with add_child(…)
The progress is allowed to discard it. Read more
Get the name of the instance as given when creating it with add_child(…)
The progress is allowed to not be named, thus there is no guarantee that a previously set names ‘sticks’. Read more
Create a message
of the given level
and store it with the progress tree. Read more
Increment the current progress to the given 1. The cost of this call is negligible, making manual throttling not necessary. Read more
Create a message providing additional information about the progress thus far.
Create a message indicating the task is done successfully
A shorthand to print throughput information
A shorthand to print throughput information, with the given step and unit