Struct metrix::snapshot::Snapshot

pub struct Snapshot {
    pub items: Vec<(String, ItemKind)>,
}

A Snapshot which contains measured values at a point in time.

Fields

items: Vec<(String, ItemKind)>

Methods

impl Snapshot

pub fn push<K: Into<String>>(&mut self, k: K, v: ItemKind)

pub fn find_with_separator(     &self,     path: &str,     separator: char ) -> Option<&ItemKind>

Find an item on a path with a given a separator.

Same as find but with a configurable seperator.

pub fn find(&self, path: &str) -> Option<&ItemKind>

Find an item on a path with a / as a separator.

If the path is empty None is returned.

Since a Snapshot may contain multiple items with the same name only the first found will be returned.

If a prefix of a path leads to a value that value is returned and the rest of the path is discarded.

Empty segments of a path are ignored.

Example

use metrix::snapshot::*;

// a -> 23
// b -> c -> 42

let inner = ItemKind::Snapshot(Snapshot {
    items: vec![("c".to_string(), ItemKind::UInt(42))],
});

let snapshot = Snapshot {
    items: vec![
        ("a".to_string(), ItemKind::UInt(23)),
        ("b".to_string(), inner.clone()),
    ],
};

assert_eq!(snapshot.find("a"), Some(&ItemKind::UInt(23)));
assert_eq!(snapshot.find("a/x"), Some(&ItemKind::UInt(23)));
assert_eq!(snapshot.find("/a/x"), Some(&ItemKind::UInt(23)));

assert_eq!(snapshot.find("b"), Some(&inner));

assert_eq!(snapshot.find("b/c"), Some(&ItemKind::UInt(42)));
assert_eq!(snapshot.find("/b//c"), Some(&ItemKind::UInt(42)));

assert_eq!(snapshot.find("b/c/x"), Some(&ItemKind::UInt(42)));

assert_eq!(snapshot.find(""), None);

assert_eq!(snapshot.find("/"), None);

pub fn to_default_json(&self) -> String

Output JSON with default settings.

pub fn to_json(&self, config: &JsonConfig) -> String

Output JSON with the given settings.

Trait Implementations

impl Debug for Snapshot

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

Formats the value using the given formatter.

impl Clone for Snapshot

fn clone(&self) -> Snapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for Snapshot

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

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

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

This method tests for !=.

impl Default for Snapshot

fn default() -> Snapshot

Returns the "default value" for a type.