Enum sise::Node

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

A SISE 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<Node>)

A list of nodes

Methods

impl Node

pub fn ref_as_usize(&self) -> usize

Bitcasts the reference to self to usize. Useful to insert it in a HashSet<usize>, which is used by sise::SpacedSerializeStyle.

Example

let node = sise::Node::Atom(String::from("example"));
assert_eq!(node.ref_as_usize(), &node as *const sise::Node as usize);

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<Node>>

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<Node>>

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<Node>>

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_expr;

let tree = sise_expr!(["example", ["1", "2", "3"], ["a", "b", "c"]]);
assert_eq!(*tree.index_path(&[0]).unwrap(), "example");
assert_eq!(*tree.index_path(&[1]).unwrap(), sise_expr!(["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 PartialEq<Node> for Node

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

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

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

This method tests for !=.

impl PartialEq<str> for Node

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<&'_ str> for Node

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<String> for Node

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for Node

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

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

Performs the conversion.

impl From<String> for Node

fn from(atom: String) -> Node

Performs the conversion.

impl From<Vec<Node>> for Node

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

Performs the conversion.

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for Node

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 Debug for Node

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

Formats the value using the given formatter.