Struct NodeTree 

pub struct NodeTree<D, T> {
    pub data: Option<D>,
    pub node: Node<T>,
}

A hashmap-like data structure for organizing general data into recursive subnodes. Data is indexed and traversed using paths. It retains the order of insertion.

📏 Structure

All data is stored inside inner tree-like hierarchy. Each node can store users data and multiple subnodes.

> NodeTree
 |-> Node_1
 |    |-> Node_2
 |    |-> Node_3
 |    |    |-> Node_4
 |-> Node_5
 |    |-> Node_6

⚙️ Paths

Paths are strings that are passed to the methods to retrive and mutate data. For example "foo/bar/bar" is a valid path syntax. You need to construct paths always from the point of view of the struct we pass them to. For example on the previous hierarchy:

If you want to access Node_4, you use path "Node_1/Node_3/Node_4" on NodeTree struct. You can also use "Node_3/Node_4" on Node_1 struct to get the same result.

Whitespaces are allowed in paths, but are not encouraged. Putting a dot as first symbol like this ".name" will hide the node from the tree. Just "." will refer to the same node. ".." is not supported and is actually a valid name.

You can also not specify the name when creating a node. That means the name will be generated. The format is as follows ".||#:N" with N being the .len() of the nodes hashmap.

📦 Types

• Generic (D) - Master data schema struct defining what surface data can be stored in NodeTree for all nodes to share.
• Generic (N) - Node data schema struct defining what node-specific data can be stored in Node

⚠️ Warning

Please refrain from manually using ".||#:0", ".||#:1", ".||#:2", … as names or NodeGeneralTrait::add_node will return errors.

Fields

data: Option<D>

Top-level data

This top-level data is meant to be shared for every node. Example usage is storing theme and other surface data.

node: Node<T>

Node

The starting root node.

Trait Implementations

impl<D: Clone, T: Clone> Clone for NodeTree<D, T>

fn clone(&self) -> NodeTree<D, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D, T> Component for NodeTree<D, T>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl<D: Debug, T: Debug> Debug for NodeTree<D, T>

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

Formats the value using the given formatter.

impl<D: Default, T: Default> Default for NodeTree<D, T>

fn default() -> NodeTree<D, T>

Returns the “default value” for a type.

impl<D, T> From<NodeTree<D, T>> for Node<T>

fn from(val: NodeTree<D, T>) -> Self

Converts to this type from the input type.

impl<D, T> NodeCreationTrait<T> for NodeTree<D, T>

fn make_node(&mut self, name: impl Borrow<str>) -> Result<String, NodeError>

Makes new subnode in this node and returns the new subnodes’ name.

fn create_node(&mut self, path: impl Borrow<str>) -> Result<String, NodeError>

🚸 Recursive

fn obtain_or_create_node( &mut self, name: impl Borrow<str>, ) -> Result<&Node<T>, NodeError>

Borrows subnode from this node. If the node doesn’t exist, it creates one.

fn obtain_or_create_node_mut( &mut self, name: impl Borrow<str>, ) -> Result<&mut Node<T>, NodeError>

Borrows subnode from this node as mut. If the node doesn’t exist, it creates one.

fn borrow_or_create_node( &mut self, path: impl Borrow<str>, ) -> Result<&Node<T>, NodeError>

🚸 Recursive

fn borrow_or_create_node_mut( &mut self, path: impl Borrow<str>, ) -> Result<&mut Node<T>, NodeError>

🚸 Recursive

impl<D, T> NodeDataTrait<T> for NodeTree<D, T>

fn add_data(&mut self, data: T) -> Option<T>

Adds new data to this node and returns the previous data.

fn insert_data( &mut self, path: impl Borrow<str>, data: T, ) -> Result<Option<T>, NodeError>

🚸 Recursive

fn take_data(&mut self) -> Option<T>

Removes data from this node and returns them.

fn remove_data( &mut self, path: impl Borrow<str>, ) -> Result<Option<T>, NodeError>

🚸 Recursive

fn obtain_data(&self) -> Option<&T>

Borrows data from this node.

fn obtain_data_mut(&mut self) -> Option<&mut T>

Borrows data from this node as mut.

fn borrow_data(&self, path: impl Borrow<str>) -> Result<Option<&T>, NodeError>

🚸 Recursive

fn borrow_data_mut( &mut self, path: impl Borrow<str>, ) -> Result<Option<&mut T>, NodeError>

🚸 Recursive

impl<D, T: NiceDisplay> NodeDisplayTrait<T> for NodeTree<D, T>

fn tree(&self, params: impl Borrow<str>) -> String

Generates overview of the inner structure of subnodes as a printable string. You can supply additional parameters like show-hidden.

impl<D, T> NodeGeneralTrait<T> for NodeTree<D, T>

fn add_node( &mut self, name: impl Borrow<str>, node: impl Into<Node<T>>, ) -> Result<String, NodeError>

Adds new subnode to this node and returns the new subnodes’ name.

fn insert_node( &mut self, path: impl Borrow<str>, node: impl Into<Node<T>>, ) -> Result<String, NodeError>

🚸 Recursive

fn take_node(&mut self, name: impl Borrow<str>) -> Result<Node<T>, NodeError>

Removes subnode from this node and returns it.

fn remove_node(&mut self, path: impl Borrow<str>) -> Result<Node<T>, NodeError>

🚸 Recursive

fn obtain_node(&self, name: impl Borrow<str>) -> Result<&Node<T>, NodeError>

Borrows subnode from this node.

fn obtain_node_mut( &mut self, name: impl Borrow<str>, ) -> Result<&mut Node<T>, NodeError>

Borrows subnode from this node as mut.

fn borrow_node(&self, path: impl Borrow<str>) -> Result<&Node<T>, NodeError>

🚸 Recursive

fn borrow_node_mut( &mut self, path: impl Borrow<str>, ) -> Result<&mut Node<T>, NodeError>

🚸 Recursive

fn merge(&mut self, node: impl Into<Node<T>>) -> Result<(), NodeError>

Merges subnodes of supplied node or nodetree into this node.

fn crawl(&self) -> Vec<&Node<T>>

Recursively iterates over all subnodes and returns them in a single vector.

fn tree_node(&self, params: impl Borrow<str>) -> String

Generates overview of the inner structure of subnodes as a printable string.

fn get_name(&self) -> &String

Returns name of the node. Cached & Read-only.

fn get_path(&self) -> &String

Returns depth within the hierarchy. Cached & Read-only.

fn get_depth(&self) -> f32

Returns full path without the name. Cached & Read-only.

impl<D, T> NodeTopDataTrait<D> for NodeTree<D, T>

fn add_topdata(&mut self, data: D) -> Option<D>

Adds new top-level data and returns previous top-level data.

fn take_topdata(&mut self) -> Option<D>

Removes top-level data and returns it.

fn obtain_topdata(&self) -> Option<&D>

Borrows top-level data.

fn obtain_topdata_mut(&mut self) -> Option<&mut D>

Borrows top-level data as mut.

impl<D, T> NodeTreeInitTrait for NodeTree<D, T>

fn new(name: impl Borrow<str>) -> Self

Creates new NodeTree.

impl<D: PartialEq, T: PartialEq> PartialEq for NodeTree<D, T>

fn eq(&self, other: &NodeTree<D, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<D, T> StructuralPartialEq for NodeTree<D, T>