Struct console_api::tasks::Task

pub struct Task {
    pub id: Option<Id>,
    pub metadata: Option<MetaId>,
    pub kind: i32,
    pub fields: Vec<Field>,
    pub parents: Vec<SpanId>,
    pub location: Option<Location>,
}

Data recorded when a new task is spawned.

Fields

id: Option<Id>

The task’s ID.

This uniquely identifies this task across all currently live tasks. When the task’s stats change, or when the task completes, it will be identified by this ID; if the client requires additional information included in the Task message, it should store that data and access it by ID.

metadata: Option<MetaId>

The numeric ID of the task’s Metadata.

This identifies the Metadata that describes the tracing span corresponding to this task. The metadata for this ID will have been sent in a prior RegisterMetadata message.

kind: i32

The category of task this task belongs to.

fields: Vec<Field>

A list of Field objects attached to this task.

parents: Vec<SpanId>

An ordered list of span IDs corresponding to the tracing span context in which this task was spawned.

The first span ID in this list is the immediate parent, followed by that span’s parent, and so on. The final ID is the root span of the current trace.

If this is empty, there were no active spans when the task was spawned.

These IDs may correspond to tracing spans which are not tasks, if additional trace data is being collected.

location: Option<Location>

The location in code where the task was spawned.

Implementations

impl Task

pub fn kind(&self) -> Kind

Returns the enum value of kind, or the default if the field is set to an invalid enum value.

pub fn set_kind(&mut self, value: Kind)

Sets kind to the provided enum value.

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Task

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

Formats the value using the given formatter.

impl Default for Task

fn default() -> Self

Returns the “default value” for a type.

impl Message for Task

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 Task

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Task