Struct prodash::tree::Root

pub struct Root { /* fields omitted */ }

The top-level of the progress tree.

Methods

impl Root

pub fn new() -> Root

Create a new tree with default configuration.

As opposed to Item instances, this type can be closed and sent safely across threads.

pub fn messages_capacity(&self) -> usize

Returns the maximum amount of messages we can keep before overwriting older ones.

pub fn num_tasks(&self) -> usize

Returns the current amount of Items stored in the tree. Note that this is at most a guess as tasks can be added and removed in parallel.

pub fn add_child(&self, name: impl Into<String>) -> Item

Adds a new child tree::Item, whose parent is this instance, with the given name.

This builds a hierarchy of tree::Items, each having their own progress. Use this method to track progress of your first tasks.

pub fn sorted_snapshot(&self, out: &mut Vec<(Key, Value)>)

Copy the entire progress tree into the given out vector, so that it can be traversed from beginning to end in order of hierarchy.

pub fn copy_messages(&self, out: &mut Vec<Message>)

Copy all messages from the internal ring buffer into the given out vector. Messages are ordered from oldest to newest.

Trait Implementations

impl Clone for Root

fn clone(&self) -> Root

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Root

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

Formats the value using the given formatter.

impl From<TreeOptions> for Tree

fn from(
    TreeOptions { initial_capacity: initial_capacity, message_buffer_capacity: message_buffer_capacity }: TreeOptions
) -> Self

Performs the conversion.