Struct rtrtr::metrics::Collection

pub struct Collection { /* private fields */ }

A collection of metrics sources.

This type provides a shared collection. I.e., if a value is cloned, both clones will reference the same collection. Both will see newly added sources.

Such new sources can be registered with the register method. A string with all the current values of all known sources can be obtained via the assemble method.

Implementations

impl Collection

pub fn register(&self, name: Arc<str>, source: Weak<dyn Source>)

Registers a new source with the collection.

The name of the component registering the source is passed via name. The source itself is given as a weak pointer so that it gets dropped when the owning component terminates.

pub fn assemble(&self, format: OutputFormat) -> String

Assembles metrics output.

Produces an output of all the sources in the collection in the given format and returns it as a string.

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Collection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Collection

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

Formats the value using the given formatter.

impl Default for Collection

fn default() -> Collection

Returns the “default value” for a type.