Struct ratio_graph::node::NodeStoreData
source · pub struct NodeStoreData { /* private fields */ }Trait Implementations§
source§impl Clone for NodeStoreData
impl Clone for NodeStoreData
source§fn clone(&self) -> NodeStoreData
fn clone(&self) -> NodeStoreData
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for NodeStoreData
impl Debug for NodeStoreData
source§impl Default for NodeStoreData
impl Default for NodeStoreData
source§fn default() -> NodeStoreData
fn default() -> NodeStoreData
Returns the “default value” for a type. Read more
source§impl<'de> Deserialize<'de> for NodeStoreData
impl<'de> Deserialize<'de> for NodeStoreData
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl HasNodeStore for NodeStoreData
impl HasNodeStore for NodeStoreData
source§fn node_store(&self) -> &NodeStoreData
fn node_store(&self) -> &NodeStoreData
Get a reference to the node store.
source§fn node_store_mut(&mut self) -> &mut NodeStoreData
fn node_store_mut(&mut self) -> &mut NodeStoreData
Get a mutable reference to the node store.
source§impl NodeStore for NodeStoreData
impl NodeStore for NodeStoreData
source§fn is_nodes_empty(&self) -> bool
fn is_nodes_empty(&self) -> bool
Whether this node store is empty.
source§fn has_node(&self, id: &Uuid) -> bool
fn has_node(&self, id: &Uuid) -> bool
Check whether this store contains a node with the given node ID.
source§fn add_node(&mut self, node: Node, safe: bool) -> Result<Option<Node>, Error>
fn add_node(&mut self, node: Node, safe: bool) -> Result<Option<Node>, Error>
Add a single node to this store. Setting ‘safe’ checks whether this node’s
references exist and detects cyclic hierarchies.
source§fn extend_nodes(
&mut self,
nodes: Vec<Node>,
safe: bool
) -> Result<Vec<Node>, Error>
fn extend_nodes( &mut self, nodes: Vec<Node>, safe: bool ) -> Result<Vec<Node>, Error>
Extend this node store with new nodes. Setting ‘safe’ checks whether all node
references exist and detects cyclic hierarchies after adding them to the store
first.
source§fn check_node(&self, node: &Node) -> Result<(), Error>
fn check_node(&self, node: &Node) -> Result<(), Error>
Check whether a node’s references exist and it doesn’t partake in cyclic
hierarchies.
source§fn get_node_err(&self, id: &Uuid) -> Result<&Node, Error>
fn get_node_err(&self, id: &Uuid) -> Result<&Node, Error>
Get a reference to a node as as result.
source§fn get_node_mut(&mut self, node_id: &Uuid) -> Option<&mut Node>
fn get_node_mut(&mut self, node_id: &Uuid) -> Option<&mut Node>
Get a mutable reference to a node.
source§fn all_node_ids(&self) -> Vec<&Uuid>
fn all_node_ids(&self) -> Vec<&Uuid>
Get all node IDs in this store.
source§fn root_nodes(&self) -> Vec<&Node>
fn root_nodes(&self) -> Vec<&Node>
Get all root nodes in this store.
source§fn leaf_nodes(&self) -> Vec<&Node>
fn leaf_nodes(&self) -> Vec<&Node>
Get all leaf nodes in this store.
source§fn set_parent(
&mut self,
child_id: &Uuid,
parent_id: Option<&Uuid>
) -> Result<(), Error>
fn set_parent( &mut self, child_id: &Uuid, parent_id: Option<&Uuid> ) -> Result<(), Error>
Set a new parent value for the given child ID. Returns an error if the child
node does not exist in the store. Setting the parent ID to None removes the
parent-child relationship.
source§fn set_bus(&mut self, node_id: &Uuid, is_bus: bool) -> Result<(), Error>
fn set_bus(&mut self, node_id: &Uuid, is_bus: bool) -> Result<(), Error>
Set the is_bus value of a given node ID.
source§fn bus_ids(&self, parent_id: &Uuid) -> Result<Vec<&Uuid>, Error>
fn bus_ids(&self, parent_id: &Uuid) -> Result<Vec<&Uuid>, Error>
Get the bus node IDs that fall directly under the given parent ID.
source§fn bus_nodes(&self, parent_id: &Uuid) -> Result<Vec<&Node>, Error>
fn bus_nodes(&self, parent_id: &Uuid) -> Result<Vec<&Node>, Error>
Get the bus nodes that fall directly under the given parent ID.
source§fn ascendant_ids(
&self,
node_id: &Uuid,
safe: bool,
only_root: bool,
root_ids: Option<&HashSet<Uuid>>,
height: Option<usize>
) -> Result<Vec<&Uuid>, Error>
fn ascendant_ids( &self, node_id: &Uuid, safe: bool, only_root: bool, root_ids: Option<&HashSet<Uuid>>, height: Option<usize> ) -> Result<Vec<&Uuid>, Error>
Get ascendant node IDs of a given node. Setting
safe checks for cyclic
hierarchies along the way. only_root only includes the final root node.
root_ids are nodes to consider as (additional) root nodes in this query.
height determines the maximum height at which the ancestor is considered a
root node.source§fn ascendant_nodes(
&self,
node_id: &Uuid,
safe: bool,
only_root: bool,
root_ids: Option<&HashSet<Uuid>>,
height: Option<usize>
) -> Result<Vec<&Node>, Error>
fn ascendant_nodes( &self, node_id: &Uuid, safe: bool, only_root: bool, root_ids: Option<&HashSet<Uuid>>, height: Option<usize> ) -> Result<Vec<&Node>, Error>
Get ascendant nodes of a given node. Setting
safe checks for cyclic
hierarchies along the way. only_root only includes the final root node.
root_ids are nodes to consider as (additional) root nodes in this query.
height determines the maximum height at which the ancestor is considered a
root node.source§fn node_depth(
&self,
node_id: &Uuid,
safe: bool,
root_ids: Option<&HashSet<Uuid>>,
height: Option<usize>
) -> Result<usize, Error>
fn node_depth( &self, node_id: &Uuid, safe: bool, root_ids: Option<&HashSet<Uuid>>, height: Option<usize> ) -> Result<usize, Error>
Node depth (i.e. the number of levels that exist above). Setting
safe checks
for cyclic hierarchies along the way. root_ids are nodes to consider as (additional) root nodes in this query.
height determines the maximum height at which the ancestor is considered a
root node.source§fn descendant_ids(
&self,
node_id: &Uuid,
safe: bool,
only_leaf: bool,
leaf_ids: Option<&HashSet<Uuid>>,
depth: Option<usize>
) -> Result<Vec<&Uuid>, Error>
fn descendant_ids( &self, node_id: &Uuid, safe: bool, only_leaf: bool, leaf_ids: Option<&HashSet<Uuid>>, depth: Option<usize> ) -> Result<Vec<&Uuid>, Error>
Get the descendant node IDs of a given node. Setting
safe checks for cyclic
hierarchies. Setting only_leaf only includes only absolute or specified leaf
nodes in the result. leaf_ids restricts the search at the given node IDs,
disallowing it from going any further. depth specifies the maximum depth at
which nodes are also considered leaf nodes for this search.source§fn descendant_nodes(
&self,
node_id: &Uuid,
safe: bool,
only_leaf: bool,
leaf_ids: Option<&HashSet<Uuid>>,
depth: Option<usize>
) -> Result<Vec<&Node>, Error>
fn descendant_nodes( &self, node_id: &Uuid, safe: bool, only_leaf: bool, leaf_ids: Option<&HashSet<Uuid>>, depth: Option<usize> ) -> Result<Vec<&Node>, Error>
Get the descendant nodes of a given node. Setting
safe checks for cyclic
hierarchies. Setting only_leaf only includes only absolute or specified leaf
nodes in the result. leaf_ids restricts the search at the given node IDs,
disallowing it from going any further. depth specifies the maximum depth with
respect to the given node ID to search at.source§fn node_height(
&self,
node_id: &Uuid,
safe: bool,
depth: Option<usize>,
leaf_ids: Option<&HashSet<Uuid>>
) -> Result<usize, Error>
fn node_height( &self, node_id: &Uuid, safe: bool, depth: Option<usize>, leaf_ids: Option<&HashSet<Uuid>> ) -> Result<usize, Error>
Node height (i.e. the number of levels that exist below). Setting
safe checks
for cyclic hierarchies. leaf_ids restricts the search at the given node IDs,
disallowing it from going any further. depth specifies the maximum depth with
respect to the given node ID to search at.source§fn node_width(
&self,
node_id: &Uuid,
safe: bool,
leaf_ids: Option<&HashSet<Uuid>>,
depth: Option<usize>
) -> Result<usize, Error>
fn node_width( &self, node_id: &Uuid, safe: bool, leaf_ids: Option<&HashSet<Uuid>>, depth: Option<usize> ) -> Result<usize, Error>
Node width in terms of (optionally specified) leaf nodes. Setting
safe checks
for cyclic hierarchies. leaf_ids restricts the search at the given node IDs,
disallowing it from going any further. depth specifies the maximum depth with
respect to the given node ID to search at.source§impl PartialEq<NodeStoreData> for NodeStoreData
impl PartialEq<NodeStoreData> for NodeStoreData
source§fn eq(&self, other: &NodeStoreData) -> bool
fn eq(&self, other: &NodeStoreData) -> bool
This method tests for
self and other values to be equal, and is used
by ==.source§impl Serialize for NodeStoreData
impl Serialize for NodeStoreData
impl StructuralPartialEq for NodeStoreData
Auto Trait Implementations§
impl RefUnwindSafe for NodeStoreData
impl Send for NodeStoreData
impl Sync for NodeStoreData
impl Unpin for NodeStoreData
impl UnwindSafe for NodeStoreData
Blanket Implementations§
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.