Struct Label 

#[repr(C)]
pub struct Label {
    pub key: Record<StringOffset, 1, OPT_ZERO>,
    pub str: Record<StringOffset, 2, OPT_ZERO>,
    pub num: Record<i64, 3, OPT_ZERO>,
    pub num_unit: Record<StringOffset, 4, OPT_ZERO>,
}

A label includes additional context for this sample. It can include things like a thread id, allocation size, etc.

Fields

key: Record<StringOffset, 1, OPT_ZERO>

An annotation for a sample, e.g. “allocation_size”.

str: Record<StringOffset, 2, OPT_ZERO>

At most, one of the str and num should be used.

num: Record<i64, 3, OPT_ZERO>

At most, one of the str and num should be used.

num_unit: Record<StringOffset, 4, OPT_ZERO>

Should only be present when num is present. Specifies the units of num. Use arbitrary string (for example, “requests”) as a custom count unit. If no unit is specified, consumer may apply heuristic to deduce it.

Trait Implementations

impl Clone for Label

fn clone(&self) -> Label

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Label

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

Formats the value using the given formatter.

impl Default for Label

fn default() -> Label

Returns the “default value” for a type.

impl Hash for Label

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 PartialEq for Label

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

Safety

The Default implementation will return all zero-representations.

const WIRE_TYPE: WireType = WireType::LengthDelimited

The wire type this value uses.

fn proto_len(&self) -> u64

The number of bytes it takes to encode this value. Do not include the number of bytes it takes to encode the length-prefix as a varint. For example, using this snippet of the reference:

fn encode<W: Write>(&self, writer: &mut W) -> Result<()>

Encode the value to the in-wire protobuf format. For length-delimited types, do not include the length-prefix; see Value::proto_len for more details.

impl Copy for Label

impl Eq for Label

impl StructuralPartialEq for Label