Struct diagnostics_hierarchy::DiagnosticsHierarchy

pub struct DiagnosticsHierarchy<Key = String> {
    pub name: String,
    pub properties: Vec<Property<Key>>,
    pub children: Vec<DiagnosticsHierarchy<Key>>,
    pub missing: Vec<MissingValue>,
}

A hierarchy of nodes representing structured data, such as Inspect or structured log data.

Each hierarchy consists of properties, and a map of named child hierarchies.

Fields

name: String

The name of this node.

properties: Vec<Property<Key>>

The properties for the node.

children: Vec<DiagnosticsHierarchy<Key>>

The children of this node.

missing: Vec<MissingValue>

Values that were impossible to load.

Implementations

impl<Key> DiagnosticsHierarchy<Key>

where Key: AsRef<str>,

pub fn sort(&mut self)

Sorts the properties and children of the diagnostics hierarchy by name.

pub fn new_root() -> Self

Creates a new empty diagnostics hierarchy with the root node named “root”.

pub fn new( name: impl Into<String>, properties: Vec<Property<Key>>, children: Vec<DiagnosticsHierarchy<Key>>, ) -> Self

Creates a new diagnostics hierarchy with the given name for the root and the given properties and children under that root.

pub fn get_or_add_child_mut<T>( &mut self, name: T, ) -> &mut DiagnosticsHierarchy<Key>

where T: AsRef<str>,

Either returns an existing child of self with name name or creates a new child with name name.

pub fn add_child(&mut self, insert: DiagnosticsHierarchy<Key>)

Add a child to this DiagnosticsHierarchy.

Note: It is possible to create multiple children with the same name using this method, but readers may not support such a case.

pub fn get_or_add_node<T>( &mut self, node_path: &[T], ) -> &mut DiagnosticsHierarchy<Key>

where T: AsRef<str>,

Creates and returns a new Node whose location in a hierarchy rooted at self is defined by node_path.

Requires: that node_path is not empty. Requires: that node_path begin with the key fragment equal to the name of the node that add is being called on.

NOTE: Inspect VMOs may allow multiple nodes of the same name. In this case, the first node found is returned.

pub fn add_property(&mut self, property: Property<Key>)

Inserts a new Property into this hierarchy.

pub fn add_property_at_path<T>( &mut self, node_path: &[T], property: Property<Key>, )

where T: AsRef<str>,

Inserts a new Property into a Node whose location in a hierarchy rooted at self is defined by node_path.

Requires: that node_path is not empty. Requires: that node_path begin with the key fragment equal to the name of the node that add is being called on.

NOTE: Inspect VMOs may allow multiple nodes of the same name. In this case, the property is added to the first node found.

pub fn property_iter(&self) -> DiagnosticsHierarchyIterator<'_, Key>

Provides an iterator over the diagnostics hierarchy returning properties in pre-order.

pub fn add_missing(&mut self, reason: MissingValueReason, name: String)

Adds a value that couldn’t be read. This can happen when loading a lazy child.

pub fn get_property(&self, name: &str) -> Option<&Property<Key>>

Returns the property of the given |name| if one exists.

pub fn get_child(&self, name: &str) -> Option<&DiagnosticsHierarchy<Key>>

Returns the child of the given |name| if one exists.

pub fn get_child_mut( &mut self, name: &str, ) -> Option<&mut DiagnosticsHierarchy<Key>>

Returns a mutable reference to the child of the given |name| if one exists.

pub fn get_child_by_path( &self, path: &[&str], ) -> Option<&DiagnosticsHierarchy<Key>>

Returns the child of the given |path| if one exists.

pub fn get_child_by_path_mut( &mut self, path: &[&str], ) -> Option<&mut DiagnosticsHierarchy<Key>>

Returns a mutable reference to the child of the given |path| if one exists.

pub fn get_property_by_path(&self, path: &[&str]) -> Option<&Property<Key>>

Returns the property of the given |name| if one exists.

Trait Implementations

impl<Key: Clone> Clone for DiagnosticsHierarchy<Key>

fn clone(&self) -> DiagnosticsHierarchy<Key>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Key: Debug> Debug for DiagnosticsHierarchy<Key>

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

Formats the value using the given formatter.

impl<'de, Key> Deserialize<'de> for DiagnosticsHierarchy<Key>

where Key: FromStr + Clone + Hash + Eq + AsRef<str>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K: Clone> DiagnosticsHierarchyGetter<K> for DiagnosticsHierarchy<K>

fn get_diagnostics_hierarchy(&self) -> Cow<'_, DiagnosticsHierarchy<K>>

impl<Key: PartialEq> PartialEq for DiagnosticsHierarchy<Key>

fn eq(&self, other: &DiagnosticsHierarchy<Key>) -> 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<Key> Serialize for DiagnosticsHierarchy<Key>

where Key: AsRef<str>,

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<Key> StructuralPartialEq for DiagnosticsHierarchy<Key>