Struct etree::ETree

pub struct ETree { /* private fields */ }

Element tree

etree.ETree stores a sequence of etree.ETreeNode.

Implementations

impl ETree

pub fn parse_file<P: AsRef<Path>>(path: P) -> ETree

pub fn parse_str(content: &str) -> ETree

pub fn write_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

pub fn get_enable_index(&self) -> bool

get whether index feature is enabled

pub fn set_enable_index(&mut self, enable_index: bool)

set whether index feature is enabled (usable for function pos())

pub fn get_version(&self) -> Option<String>

get XML version

pub fn set_version(&mut self, version: &str)

set XML version

pub fn get_encoding(&self) -> Option<String>

get XML encoding

pub fn set_encoding(&mut self, encoding: &str)

set XML encoding

pub fn get_standalone(&self) -> Option<String>

get XML standalone

pub fn set_standalone(&mut self, standalone: &str)

set XML standalone

pub fn root(&self) -> usize

get position of root node

pub fn parent(&self, pos: usize) -> Option<usize>

get position of parent node

pub fn children(&self, pos: usize) -> Vec<usize>

get positions of children node

pub fn children_by_name(&self, pos: usize, tagname: &str) -> Vec<usize>

get positions of children node with specified name

pub fn descendant(&self, pos: usize) -> Vec<usize>

get positions of descendant node

pub fn previous(&self, pos: usize) -> Option<usize>

get position of previous sibling node

pub fn next(&self, pos: usize) -> Option<usize>

get position of next sibling node

pub fn pos(&self, idx: usize) -> Option<usize>

get position by idx

pub fn node(&self, pos: usize) -> Option<&ETreeNode>

get node by position

pub fn node_mut(&mut self, pos: usize) -> Option<&mut ETreeNode>

get mut node by position

pub fn subtree(&self, pos: usize) -> ETree

clone a subtree rooted at the node of specified position

pub fn append_previous_node(
    &mut self,
    pos: usize,
    node: ETreeNode
) -> Option<usize>

append sibling node before the node of specified position and return the position of sibling node

Warning: position which is larger than return value and obtained before this function all should be re-obtained

pub fn append_next_node(&mut self, pos: usize, node: ETreeNode) -> Option<usize>

append sibling node after the node of specified position and return the position of sibling node

Warning: position which is larger than return value and obtained before this function all should be re-obtained

pub fn append_child_node(&mut self, pos: usize, node: ETreeNode) -> Option<usize>

append child node below the node of specified position and return the position of child node

Warning: position which is larger than return value and obtained before this function all should be re-obtained

pub fn append_previous_tree(&mut self, pos: usize, tree: ETree) -> Option<usize>

append sibling tree before the node of specified position and return the position of sibling tree

Warning: position which is larger than return value and obtained before this function all should be re-obtained

pub fn append_next_tree(&mut self, pos: usize, tree: ETree) -> Option<usize>

append sibling tree after the node of specified position and return the position of sibling tree

Warning: position which is larger than return value and obtained before this function all should be re-obtained

pub fn append_child_tree(&mut self, pos: usize, tree: ETree) -> Option<usize>

append child tree below the node of specified position and return the position of child tree

Warning: position which is larger than return value and obtained before this function all should be re-obtained

pub fn remove(&mut self, pos: usize)

remove a subtree rooted at the node of specified position

Warning: position which is larger than specified value and obtained before this function all should be re-obtained

pub fn noindent(&mut self) -> String

clear indent and return old indent

pub fn pretty(&mut self, indent: &str)

format nodes according to indent

pub fn find(&self, path: &str) -> Option<usize>

find the first node that matches path from the root node

pub fn find_at(&self, path: &str, pos: usize) -> Option<usize>

find the first node that matches path from specified node

pub fn find_iter(&self, path: &str) -> XPathIterator<'_>

find nodes that matches path from the root node

pub fn find_at_iter(&self, path: &str, pos: usize) -> XPathIterator<'_>

find nodes that matches path from specified node

pub fn rfind(&self, path: &str) -> Option<usize>

find the last node that matches path from the root node

pub fn rfind_at(&self, path: &str, pos: usize) -> Option<usize>

find the last node that matches path from specified node

pub fn rfind_iter(&self, path: &str) -> XPathIterator<'_>

find nodes in reverse order that matches path from the root node

pub fn rfind_at_iter(&self, path: &str, pos: usize) -> XPathIterator<'_>

find nodes in reverse order that matches path from specified node

Trait Implementations

impl Clone for ETree

fn clone(&self) -> ETree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ETree

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

Formats the value using the given formatter.

impl From<ETreeNode> for ETree

transform root node into a tree

fn from(node: ETreeNode) -> Self

Converts to this type from the input type.