Struct ShutdownReport 

pub struct ShutdownReport {

    pub name: String,
    pub elapsed: Duration,
    pub completed: usize,
    pub cancelled: usize,
    pub aborted: usize,
    pub failed: usize,
    pub panicked: usize,
    pub timed_out: usize,
    pub leaked: usize,
    pub blocking_still_running: usize,
    pub children: Vec<ShutdownReport>,
    pub remaining_tasks: Vec<TaskSnapshot>,
    pub remaining_tasks_omitted: usize,
    pub blocking_tasks: Vec<BlockingTaskSnapshot>,
    pub annotations: Vec<ShutdownAnnotation>,
}

Represents shutdown report.

Fields

name: String

The name value.

elapsed: Duration

The elapsed value.

completed: usize

The completed value.

cancelled: usize

The cancelled value.

aborted: usize

The aborted value.

failed: usize

Lifecycle components that completed with an explicit failure.

panicked: usize

The panicked value.

timed_out: usize

Tasks this shutdown aborted after its deadline expired, plus tasks still registered when it finished.

leaked: usize

Tasks still registered when the shutdown finished.

blocking_still_running: usize

The blocking still running value.

children: Vec<ShutdownReport>

The children value.

remaining_tasks: Vec<TaskSnapshot>

Tasks still registered when the shutdown finished, at most Self::REMAINING_TASKS_LIMIT of them.

remaining_tasks_omitted: usize

Remaining tasks left out of remaining_tasks because of its limit. They are still counted in leaked.

blocking_tasks: Vec<BlockingTaskSnapshot>

The blocking tasks value.

annotations: Vec<ShutdownAnnotation>

The annotations value.

Implementations

impl ShutdownReport

pub const REMAINING_TASKS_LIMIT: usize = 64

Maximum number of task snapshots kept in remaining_tasks.

The limit bounds the size of a report for a group that leaks many tasks; the counters stay exact.

pub fn new(name: impl Into<String>, elapsed: Duration) -> Self

Creates a new ShutdownReport.

pub fn is_healthy(&self) -> bool

Returns whether healthy.

pub fn assert_no_task_leak(&self) -> Result<(), String>

Returns the assert no task leak.

pub fn log_if_unhealthy(&self)

Executes log if unhealthy.

pub fn to_json(&self) -> String

Converts this value to json.

pub fn merge_blocking(&mut self, snapshot: BlockingExecutorSnapshot)

Executes merge blocking.

Trait Implementations

impl Clone for ShutdownReport

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownReport

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

Formats the value using the given formatter.

impl Serialize for ShutdownReport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.