Struct console_api::Attribute

pub struct Attribute {
    pub field: Option<Field>,
    pub unit: Option<String>,
}

State attributes of an entity. These are dependent on the type of the entity.

For example, a timer resource will have a duration, while a semaphore resource may have a permit count. Likewise, the async ops of a semaphore may have attributes indicating how many permits they are trying to acquire vs how many are acquired. These values may change over time. Therefore, they live in the runtime stats rather than the static data describing the entity.

Fields

field: Option<Field>

The key-value pair for the attribute

unit: Option<String>

Some values carry a unit of measurement. For example, a duration carries an associated unit of time, such as “ms” for milliseconds.

Implementations

impl Attribute

pub fn unit(&self) -> &str

Returns the value of unit, or the default value if unit is unset.

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl Default for Attribute

fn default() -> Self

Returns the “default value” for a type.

impl Message for Attribute

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 Attribute

fn eq(&self, other: &Attribute) -> 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 Attribute