Skip to main content

Observer

Struct Observer 

Source
pub struct Observer { /* private fields */ }
Expand description

A read-only, cloneable view of a phase and its subtree, usable from any thread. Holding one keeps the job’s records alive.

Implementations§

Source§

impl Observer

Source

pub fn id(&self) -> NodeId

The observed phase’s identity.

Source

pub fn summary(&self) -> Summary

Read weighted progress without allocating or copying phase names. Walks this subtree; sample at a display cadence, not on every report.

Source

pub fn try_summary(&self) -> Option<Summary>

Read a summary without waiting for a metadata lock. Retry on a later turn.

Source

pub fn name(&self) -> &str

This phase’s stable name; duplicate names are distinguished by id.

Source

pub fn snapshot(&self) -> Snapshot

Take a snapshot now.

Each phase’s metadata is internally consistent; counters in different phases are read one after another, not atomically together. A finished subtree’s snapshot is frozen. This allocates and walks the subtree, so the caller chooses how often to sample.

Source

pub fn try_snapshot(&self) -> Option<Snapshot>

Take a snapshot without waiting for a lock held by another thread.

Returns None if any phase’s metadata is being replaced at that moment; try again on a later UI or event-loop turn. It never spins. Without std, entry into the platform’s critical section is up to its provider; allocation and the tree walk happen outside it.

Source

pub fn is_finished(&self) -> bool

Whether the phase has an outcome, without walking the tree.

Source

pub fn children(&self) -> Vec<Observer>

Observers of this phase’s planned children, in declared order; empty for a leaf. Copies one list of handles, without walking the subtree.

Trait Implementations§

Source§

impl Clone for Observer

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Observer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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, 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.