Struct bioyino_metric::name::MetricName

pub struct MetricName {
    pub name: Bytes,
    // some fields omitted
}

Represents a metric name as a buffer containing the full metric name including tags. Also provides methods to work with tags.

Fields

name: Bytes

Methods

impl MetricName

pub fn new<B: AsMut<[u8]>>(
    name: BytesMut,
    mode: TagFormat,
    intermediate: &mut B
) -> Result<Self, ()>

pub fn new_untagged(name: BytesMut) -> Self

Convenience method to create metric that is for sure has no tags in any format

pub fn from_raw_parts(name: Bytes, tag_pos: Option<usize>) -> Self

Assemble name from internal parts without checks. Tags must be sorted, tag position must be found according to required format

pub fn has_tags(&mut self) -> bool

true if metric is tagged

pub fn name_without_tags(&self) -> &[u8]

returns only name, without tags, considers tag position was already found before

pub fn name_with_tags(&self) -> &[u8]

returns slice with full name, including tags

pub fn tags_without_name(&self) -> &[u8]

returns slice with only tags, includes leading semicolon, expects tag position was already found

pub fn tags_len(&self) -> usize

returns length of tags field, including leading semicolon considers tag position was already found before

pub fn put_with_aggregate<F>(
    &self,
    buf: &mut BytesMut,
    dest: AggregationDestination,
    agg: Aggregate<F>,
    postfix_replacements: &HashMap<Aggregate<F>, String>,
    prefix_replacements: &HashMap<Aggregate<F>, String>,
    tag_replacements: &HashMap<Aggregate<F>, String>
) -> Result<(), ()> where
    F: Float + Debug + FromF64 + AsPrimitive<usize>, 

Puts a name with an aggregate to provided buffer depending on dest. To avoid putting different aggregates into same names requires all replacements to exist, giving error otherwise. Does no do the check if such overriding is done.

Trait Implementations

impl Clone for MetricName

fn clone(&self) -> MetricName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricName

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

Formats the value using the given formatter.

impl Eq for MetricName

impl Hash for MetricName

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<MetricName> for MetricName

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for MetricName