Trait prodash::Root

pub trait Root {
    type WeakRoot: WeakRoot;

    // Required methods
    fn messages_capacity(&self) -> usize;
    fn num_tasks(&self) -> usize;
    fn sorted_snapshot(&self, out: &mut Vec<(Key, Task)>);
    fn copy_messages(&self, out: &mut Vec<Message>);
    fn copy_new_messages(
        &self,
        out: &mut Vec<Message>,
        prev: Option<MessageCopyState>
    ) -> MessageCopyState;
    fn downgrade(&self) -> Self::WeakRoot;
}

The top level of a progress task hierarchy, with progress::Tasks identified with progress::Keys

Required Associated Types

type WeakRoot: WeakRoot

The type implementing the WeakRoot trait

Required Methods

fn messages_capacity(&self) -> usize

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

fn num_tasks(&self) -> usize

Returns the current amount of tasks underneath the root, transitively. Note that this is at most a guess as tasks can be added and removed in parallel.

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

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

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.

fn copy_new_messages( &self, out: &mut Vec<Message>, prev: Option<MessageCopyState> ) -> MessageCopyState

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

fn downgrade(&self) -> Self::WeakRoot

Similar to Arc::downgrade()

Implementations on Foreign Types

impl Root for Arc<Root>

type WeakRoot = Weak<Root>

fn messages_capacity(&self) -> usize

fn num_tasks(&self) -> usize

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

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

fn copy_new_messages( &self, out: &mut Vec<Message>, prev: Option<MessageCopyState> ) -> MessageCopyState

fn downgrade(&self) -> Self::WeakRoot

Implementors