Enum sise::TreeNode

pub enum TreeNode {
    Atom(String),
    List(Vec<TreeNode>),
}

A SISE tree node.

Variants

Atom(String)

An atom, that matches the following regular expression:

"([:atomchar:]|\"(\\([:stringchar:]|\\|\")|[:stringchar:])+\")+"

Where :atomchar: is one of:

!, #, $, %, &, *, +, -, ., /, :, <, =, >, ?, @, _, ~

And :stringchar: is any character between ASCII space and ~, except \ and ".

Atoms are not interpreted in any way, the crate sise_atom provides functions to encode and decode atoms as strings, numbers, booleans…

List(Vec<TreeNode>)

A list of nodes

Implementations

impl TreeNode

pub fn is_atom(&self) -> bool

Return whether the node is an Atom.

pub fn is_list(&self) -> bool

Return whether the node is a List.

pub fn into_atom(self) -> Option<String>

Consumes the node and returns the atom value if it is an Atom.

pub fn into_list(self) -> Option<Vec<Self>>

Consumes the node and returns the list if it is a List.

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

Returns a reference to the atom value if the node is an Atom.

pub fn as_list(&self) -> Option<&Vec<Self>>

Returns a reference to the list if the node is a List.

pub fn as_mut_atom(&mut self) -> Option<&mut String>

Returns a mutable reference to the atom value if the node is an Atom.

pub fn as_mut_list(&mut self) -> Option<&mut Vec<Self>>

Returns mutable a reference to the list if the node is a List.

pub fn index_path(&self, path: &[usize]) -> Option<&Self>

Traverses a tree with indices from path.

Example

use sise::sise_tree;

// (example (1 2 3) (a b c))
let tree = sise_tree!(["example", ["1", "2", "3"], ["a", "b", "c"]]);
assert_eq!(*tree.index_path(&[]).unwrap(), tree);
assert_eq!(*tree.index_path(&[0]).unwrap(), "example");
assert_eq!(*tree.index_path(&[1]).unwrap(), sise_tree!(["1", "2", "3"]));
assert_eq!(tree.index_path(&[1, 0]).unwrap(), "1");
assert_eq!(tree.index_path(&[2, 0]).unwrap(), "a");
assert!(tree.index_path(&[3]).is_none());
assert!(tree.index_path(&[0, 1]).is_none());

Trait Implementations

impl Clone for TreeNode

fn clone(&self) -> TreeNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeNode

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

Formats the value using the given formatter.

impl<'a> From<&'a str> for TreeNode

fn from(atom: &'a str) -> Self

Converts to this type from the input type.

impl From<String> for TreeNode

fn from(atom: String) -> Self

Converts to this type from the input type.

impl From<Vec<TreeNode, Global>> for TreeNode

fn from(list: Vec<Self>) -> Self

Converts to this type from the input type.

impl Hash for TreeNode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<&'_ str> for TreeNode

fn eq(&self, other: &&str) -> bool

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

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

This method tests for !=.

impl PartialEq<String> for TreeNode

fn eq(&self, other: &String) -> bool

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

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

This method tests for !=.

impl PartialEq<TreeNode> for TreeNode

fn eq(&self, other: &TreeNode) -> bool

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

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

This method tests for !=.

impl PartialEq<str> for TreeNode

fn eq(&self, other: &str) -> bool

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

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

This method tests for !=.

impl Eq for TreeNode

impl StructuralEq for TreeNode

impl StructuralPartialEq for TreeNode