Struct console_api::tasks::TaskUpdate

pub struct TaskUpdate {
    pub new_tasks: Vec<Task>,
    pub stats_update: HashMap<u64, Stats>,
    pub dropped_events: u64,
}

A task state update.

Each TaskUpdate contains any task data that has changed since the last update. This includes:

• any new tasks that were spawned since the last update
• the current stats for any task whose stats changed since the last update

Fields

new_tasks: Vec<Task>

A list of new tasks that were spawned since the last TaskUpdate was sent.

If this is empty, no new tasks were spawned.

stats_update: HashMap<u64, Stats>

Any task stats that have changed since the last update.

This is a map of task IDs (64-bit unsigned integers) to task stats. If a task’s ID is not included in this map, then its stats have not changed since the last TaskUpdate in which they were present. If a task’s ID is included in this map, the corresponding value represents a complete snapshot of that task’s stats at in the current time window.

dropped_events: u64

A count of how many task events (e.g. polls, spawns, etc) were not recorded because the application’s event buffer was at capacity.

If everything is working normally, this should be 0. If it is greater than 0, that may indicate that some data is missing from this update, and it may be necessary to increase the number of events buffered by the application to ensure that data loss is avoided.

If the application’s instrumentation ensures reliable delivery of events, this will always be 0.

Trait Implementations

impl Clone for TaskUpdate

fn clone(&self) -> TaskUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaskUpdate

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

Formats the value using the given formatter.

impl Default for TaskUpdate

fn default() -> Self

Returns the “default value” for a type.

impl Message for TaskUpdate

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TaskUpdate

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TaskUpdate