Struct CounterDescriptor

pub struct CounterDescriptor {
    pub type: Option<i32>,
    pub categories: Vec<String>,
    pub unit: Option<i32>,
    pub unit_name: Option<String>,
    pub unit_multiplier: Option<i64>,
    pub is_incremental: Option<bool>,
}

Defines properties of a counter track, e.g. for built-in counters (thread time, instruction count, ..) or user-specified counters (e.g. memory usage of a specific app component).

Counter tracks only support TYPE_COUNTER track events, which specify new values for the counter. For counters that require per-slice values, counter values can instead be provided in a more efficient encoding via TrackEvent’s |extra_counter_track_uuids| and |extra_counter_values| fields. However, slice-type events cannot be emitted onto a counter track.

Values for counters that are only emitted on a single packet sequence can optionally be delta-encoded, see |is_incremental|.

Next id: 7.

Fields

type: Option<i32>

For built-in counters (e.g. thread time). Custom user-specified counters (e.g. those emitted by TRACE_COUNTER macros of the client library) shouldn’t set this, and instead provide a counter name via TrackDescriptor.

categories: Vec<String>

Names of categories of the counter (usually for user-specified counters). In the client library, categories are a way to turn groups of individual counters (or events) on or off.

unit: Option<i32>

Type of the counter’s values. Built-in counters imply a value for this field.

unit_name: Option<String>

In order to use a unit not defined as a part of |Unit|, a free-form unit name can be used instead.

unit_multiplier: Option<i64>

Multiplication factor of this counter’s values, e.g. to supply COUNTER_THREAD_TIME_NS timestamps in microseconds instead.

is_incremental: Option<bool>

Whether values for this counter are provided as delta values. Only supported for counters that are emitted on a single packet-sequence (e.g. thread time). Counter values in subsequent packets on the current packet sequence will be interpreted as delta values from the sequence’s most recent value for the counter. When incremental state is cleared, the counter value is considered to be reset to 0. Thus, the first value after incremental state is cleared is effectively an absolute value.

Implementations

impl CounterDescriptor

pub fn type(&self) -> BuiltinCounterType

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

pub fn set_type(&mut self, value: BuiltinCounterType)

Sets type to the provided enum value.

pub fn unit(&self) -> Unit

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

pub fn set_unit(&mut self, value: Unit)

Sets unit to the provided enum value.

pub fn unit_multiplier(&self) -> i64

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

pub fn is_incremental(&self) -> bool

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

pub fn unit_name(&self) -> &str

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

Trait Implementations

impl Clone for CounterDescriptor

fn clone(&self) -> CounterDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CounterDescriptor

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

Formats the value using the given formatter.

impl Default for CounterDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Message for CounterDescriptor

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for CounterDescriptor

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