Struct tap::tree::Tree

pub struct Tree {
    pub root_id: TreeNodeId,
    /* private fields */
}

One of the main structure of TAP. Tt contain nodes, that contain attribute with value of different type. New nodes are generally created by the different parser, then nodes and attributes contained in the tree can be accessed via various method.

Fields

root_id: TreeNodeId

Implementations

impl Tree

pub fn new() -> Self

Create the tree and the root node.

pub fn arena(&self) -> RwLockReadGuard<'_, TreeArena>

Return the underlying tree arena.

pub fn new_node(&self, node: Node) -> TreeNodeId

Create a new node in the tree and return corresponding id.

pub fn add_child_from_id(&self, parent_id: NodeId, node_id: NodeId)

Add a node via it’s node_id as child of the parent_id node.

pub fn add_child(&self, parent_id: NodeId, node: Node) -> Result<TreeNodeId>

Create a new TreeNodeId for node, add it as child of parent_id and return the new node id

pub fn parent_id(&self, node_id: NodeId) -> Option<NodeId>

Return node id of the parent of the node.

pub fn children_id(&self, node_id: NodeId) -> Vec<NodeId>

Return the children of the provided NodeId as a Vector of NodeId.

pub fn children(&self, node_id: NodeId) -> Vec<Arc<Node>>

Return the children of the provided NodeId as a Vector of Node.

pub fn children_rec(&self, root: Option<&str>) -> Option<Vec<TreeNodeId>>

Return children from a node root path recusively as a Vec<TreeNodeId>.

pub fn children_name(&self, node_id: NodeId) -> Vec<String>

Return the name of the children for node_id.

pub fn has_children(&self, node_id: NodeId) -> bool

Check if node as children.

pub fn children_id_name(&self, node_id: NodeId) -> Vec<ChildInfo>

Return different info for all children of a node.

pub fn node_path(&self, node_id: TreeNodeId) -> Option<String>

Return a path from a node id.

pub fn get_node_from_id(&self, node_id: TreeNodeId) -> Option<TreeNode>

Return a node from a node id.

pub fn remove(&self, node_id: NodeId)

Remove node and descendants from the tree.

pub fn get_node(&self, path: &str) -> Option<TreeNode>

Return a node from a path.

pub fn find_node_from_id(
    &self,
    from_id: TreeNodeId,
    path: &str
) -> Option<TreeNodeId>

Search recursively for nodes matching path, starting from the root from_id.

pub fn get_node_id(&self, pathes: &str) -> Option<TreeNodeId>

Return a node id from node path.

pub fn count(&self) -> usize

Return number of nodes in the tree.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Tree

fn default() -> Self

Returns the “default value” for a type.

impl Display for Tree

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

Formats the value using the given formatter.

impl Serialize for Tree

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

Serialize this value into the given Serde serializer.