Skip to main content

TaskView

Struct TaskView 

Source
pub struct TaskView<'a, R: Renderer> { /* private fields */ }
Expand description

Read-only view of a task, passed to Renderer callbacks.

fn render_task_line(
    &mut self, f: &mut FrameWriter<'_>, task: &TaskView<'_, Self>,
) -> std::io::Result<()> {
    let prefix = if task.active() { ".." } else { "done" };
    writeln!(f, "[{}] {} (depth={})", prefix, task.data(), task.depth())
}

Implementations§

Source§

impl<'a, R: Renderer> TaskView<'a, R>

Source

pub fn new(tasks: &'a TaskStore<R>, id: TaskId) -> Self

Creates a view over the task with the given id.

Source

pub fn id(&self) -> TaskId

Returns TaskId of this task.

Source

pub fn data(&self) -> &R::TaskData

Returns the user-defined data stored on this task.

Source

pub fn depth(&self) -> usize

Returns the nesting depth of this task (root children are depth 1).

Source

pub fn elapsed(&self) -> Duration

How long since this task started.

Source

pub fn active(&self) -> bool

Returns true if the task is active (not completed or cancelled).

Source

pub fn completed(&self) -> bool

Returns true if the task’s span has closed.

Source

pub fn cancelled(&self) -> bool

Returns true if the task was marked cancelled by crate::Action::CancelAll.

Source

pub fn parent<'b>(&'b self) -> Option<TaskView<'b, R>>

Returns the parent task, or None for root-level tasks.

Source

pub fn events<'b>( &'b self, ) -> impl DoubleEndedIterator<Item = EventView<'b, R>> + ExactSizeIterator

Returns an iterator over the task’s buffered events.

Source

pub fn subtasks<'b>( &'b self, ) -> impl DoubleEndedIterator<Item = TaskView<'b, R>> + ExactSizeIterator

Returns an iterator over the task’s direct children.

Source

pub fn index(&self) -> usize

Returns the position of this task among its parent’s children.

Source

pub fn view(&self, id: TaskId) -> TaskView<'a, R>

Create a view of another task in the same tree.

Trait Implementations§

Source§

impl<'a, R: Clone + Renderer> Clone for TaskView<'a, R>

Source§

fn clone(&self) -> TaskView<'a, R>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, R: Copy + Renderer> Copy for TaskView<'a, R>

Auto Trait Implementations§

§

impl<'a, R> Freeze for TaskView<'a, R>

§

impl<'a, R> RefUnwindSafe for TaskView<'a, R>

§

impl<'a, R> Send for TaskView<'a, R>
where <R as Renderer>::TaskData: Sync, <R as Renderer>::EventData: Sync,

§

impl<'a, R> Sync for TaskView<'a, R>
where <R as Renderer>::TaskData: Sync, <R as Renderer>::EventData: Sync,

§

impl<'a, R> Unpin for TaskView<'a, R>

§

impl<'a, R> UnsafeUnpin for TaskView<'a, R>

§

impl<'a, R> UnwindSafe for TaskView<'a, R>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more