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

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() -> DiagnosticsHierarchy<Key>

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>> ) -> DiagnosticsHierarchy<Key>

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 for DiagnosticsHierarchy<Key>
where Key: Clone,

§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

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

§

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

Formats the value using the given formatter. Read more
§

impl<'de, Key> Deserialize<'de> for DiagnosticsHierarchy<Key>
where Key: FromStr + Clone + Hash + Eq + AsRef<str>,

§

fn deserialize<D>( deserializer: D ) -> Result<DiagnosticsHierarchy<Key>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

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

§

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

§

fn eq(&self, other: &DiagnosticsHierarchy<Key>) -> bool

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

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>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl<Key> StructuralPartialEq for DiagnosticsHierarchy<Key>

Auto Trait Implementations§

§

impl<Key> RefUnwindSafe for DiagnosticsHierarchy<Key>
where Key: RefUnwindSafe,

§

impl<Key> Send for DiagnosticsHierarchy<Key>
where Key: Send,

§

impl<Key> Sync for DiagnosticsHierarchy<Key>
where Key: Sync,

§

impl<Key> Unpin for DiagnosticsHierarchy<Key>
where Key: Unpin,

§

impl<Key> UnwindSafe for DiagnosticsHierarchy<Key>
where Key: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoAny for T
where T: 'static + Send + Sync,

§

fn into_any(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Cast the given object into a dyn std::any::Any.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,