Struct TaskScheduling 

#[non_exhaustive]
pub struct TaskScheduling {
    pub scheduled_count: u64,
    pub total_scheduled_duration: Duration,
    pub long_delay_count: u64,
}

A snapshot of the cumulative scheduling delay observed by the root instrumented task that the current future is running on.

Obtain one with TaskScheduling::try_current from inside a task that has been instrumented with TaskMonitor::instrument. Scheduling delay can only be measured by the root future the runtime schedules, so a future running within a larger task samples this at two points and reports the difference — this is exactly what FutureMonitor does to attribute scheduling delay to a single future.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

scheduled_count: u64

The number of times the task was scheduled (woken, then waiting to be polled).

total_scheduled_duration: Duration

The total time the task spent waiting to be polled after being woken.

long_delay_count: u64

The number of scheduling delays that crossed the monitor’s long-delay threshold.

Implementations

impl TaskScheduling

pub fn try_current() -> Option<TaskScheduling>

Reads the cumulative scheduling delay of the task currently being polled.

Returns None when called outside the poll of a future instrumented with TaskMonitor::instrument.

Trait Implementations

impl Clone for TaskScheduling

fn clone(&self) -> TaskScheduling

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TaskScheduling

impl Debug for TaskScheduling

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

Formats the value using the given formatter.

impl Default for TaskScheduling

fn default() -> TaskScheduling

Returns the “default value” for a type.

impl Eq for TaskScheduling

impl PartialEq for TaskScheduling

fn eq(&self, other: &TaskScheduling) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TaskScheduling