Struct opentelemetry::sdk::metrics::sdk_api::Descriptor

pub struct Descriptor { /* private fields */ }

Available on crate feature metrics only.

Descriptor contains all the settings that describe an instrument, including its name, metric kind, number kind, and the configurable options.

Implementations

impl Descriptor

pub fn new(
    name: String,
    instrument_kind: InstrumentKind,
    number_kind: NumberKind,
    description: Option<String>,
    unit: Option<Unit>
) -> Descriptor

Create a new descriptor

pub fn name(&self) -> &str

The metric instrument’s name.

pub fn instrument_kind(&self) -> &InstrumentKind

The specific kind of instrument.

pub fn number_kind(&self) -> &NumberKind

NumberKind returns whether this instrument is declared over int64, float64, or uint64 values.

pub fn description(&self) -> Option<&String>

A human-readable description of the metric instrument.

pub fn set_description(&mut self, description: String)

Assign a new description

pub fn unit(&self) -> Option<&str>

Unit describes the units of the metric instrument.

pub fn attribute_hash(&self) -> u64

The pre-computed hash of the descriptor data

Trait Implementations

impl Clone for Descriptor

fn clone(&self) -> Descriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Descriptor

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

Formats the value using the given formatter.

impl PartialEq<Descriptor> for Descriptor

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Descriptor

impl StructuralEq for Descriptor

impl StructuralPartialEq for Descriptor