Struct CounterDescriptor 

pub struct CounterDescriptor {
    pub iid: Option<u64>,
    pub name: Option<String>,
    pub unit_multiplier: Option<u64>,
    pub description: Option<String>,
    pub scope: Option<i32>,
    pub unit_field: Option<UnitField>,
}

Describes a counter: a named, typed quantity a sample is measured against (the sampling timebase) or observed alongside (a follower). Values live on the sample as weights; this only describes their meaning.

Fields

iid: Option<u64>

Interning key, used when this descriptor is emitted via InternedData.stack_sample_counter_descriptors and referenced by StackSample.primary_descriptor_iid. Starts from 1; 0 is the same as “not set”.

name: Option<String>

Human-readable counter name, e.g. “cycles”, “wall-time”, “cache-misses”.

unit_multiplier: Option<u64>

Scales raw weights to unit. E.g. unit=UNIT_BYTES, unit_multiplier=1024 means weights are in KiB. Absent means 1.

description: Option<String>

Free-form description of what the counter measures.

scope: Option<i32>

The scope of this counter’s instances. Absent means SCOPE_GLOBAL.

unit_field: Option<UnitField>

The unit weights are expressed in. Set the well-known unit when one fits, otherwise set unit_str to a custom label.

Implementations

impl CounterDescriptor

pub fn iid(&self) -> u64

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

pub fn name(&self) -> &str

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

pub fn unit_multiplier(&self) -> u64

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

pub fn description(&self) -> &str

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

pub fn scope(&self) -> Scope

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

pub fn set_scope(&mut self, value: Scope)

Sets scope to the provided enum value.

Trait Implementations

impl Clone for CounterDescriptor

fn clone(&self) -> CounterDescriptor

Returns a duplicate 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 Eq for CounterDescriptor

impl Hash for CounterDescriptor

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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(&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 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