Struct Path

pub struct Path<B> { /* private fields */ }

A path to a Tree node.

A Path is a collection of branches to follow to get to the desired node. An empty Path represents the root of the Tree.

Examples

use nb_tree::{path, prelude::{Tree, Path}};
let mut tree = Tree::new();
// Paths from string litterals, vectors, or manually built
let path_d: Path<String> = "/b/d".into();
let path_e: Path<String> = vec!["a", "c", "e"].into();
let path_g: Path<String> = path!["a", "g"];
let mut path_f = Path::new();
path_f.l("b").l("f");
// Use paths to insert data
tree.i("/", 0)
    .i("/a", 1)
    .i("/b", 2)
    .i("/a/c", 3)
    .i(path_d, 4)
    .i(path_e, 5)
    .i(path_f, 6)
    .i(path_g, 7);

// Use paths to retrieve data
assert_eq!(tree.get(&"/a/c".into()), Ok(&3));

// Use paths to remove data
assert_eq!(tree.len(), 8);
assert_eq!(tree.remove_subtree(&"/a".into()), Ok(()));
// The whole "/a/[c/e, g]" subtree is removed, removing all nodes below it too
assert_eq!(tree.len(), 4);

Implementations

impl<B> Path<B>

pub fn new() -> Self

Creates a new empty Path.

pub fn with(root: B) -> Self

Creates a new empty Path.

pub fn pop_first(&mut self) -> Option<B>

Removes the first branch of the Path.

pub fn pop_last(&mut self) -> Option<B>

Removes the last branch of the Path.

pub fn push_last(&mut self, branch: B)

Adds branch at the end of the Path.

pub fn append(&mut self, branches: Path<B>)

Appends all branches at the end of the Path.

pub fn l(&mut self, branch: impl Into<B>) -> &mut Self

Adds branch at the end of the Path.

Calls can be chained.

pub fn push_first(&mut self, branch: B)

Adds branch at the start of the Path.

pub fn last(&self) -> Option<&B>

Returns the last branch of the Path.

If the Path is empty, None is returned.

pub fn first(&self) -> Option<&B>

Returns the first branch of the Path.

If the Path is empty, None is returned.

pub fn is_empty(&self) -> bool

Returns true if the Path is empty, false otherwise.

pub fn len(&self) -> usize

Returns the length of the Path.

pub fn truncate_end(&mut self, n: usize)

Removes n branches from the end of the Path.

pub fn truncate_start(&mut self, n: usize)

Removes n branches from the start of the Path.

pub fn clear(&mut self)

Clears the Path.

pub fn iter(&self) -> Iter<'_, B>

Traverses the Tree nodes depth first.

The children are visited in arbitrary order.

pub fn range<R>(&self, range: R) -> Iter<'_, B>

where R: RangeBounds<usize>,

impl<B> Path<B>

where B: Clone,

pub fn path_to(&self, path_idx: PathIDX) -> Path<B>

Creates a copy stopping at the given index (excluded).

pub fn path_from(&self, path_idx: PathIDX) -> Path<B>

Creates a copy starting at the given index (included).

pub fn apply<N>(&mut self, node: &Traversal<N, B>) -> bool

Follows the given [DepthFirstTraversalNode], moving up the Path and going down a branch.

The branch type can be something else than B, as long as it can be converted to it.

Examples

use nb_tree::prelude::{Tree, Path};
let mut tree: Tree<usize, String> = Tree::new();
tree.i("/", 0).i("/a", 1).i("/a/b", 2);
let mut iter = tree.into_iter();
let mut path: Path<String> = Path::new();
path.apply(&iter.next().unwrap());
assert_eq!(path, "/".into());
path.apply(&iter.next().unwrap());
assert_eq!(path, "/a".into());
path.apply(&iter.next().unwrap());
assert_eq!(path, "/a/b".into());

pub fn apply_deref<N, C>(&mut self, node: &Traversal<N, C>) -> bool

where C: Deref<Target = B>,

Dereferences the branch in node and applies it like apply().

pub fn apply_with<N, C>( &mut self, node: &Traversal<N, C>, op: impl Fn(&C) -> B, ) -> bool

Follows the given [DepthFirstTraversalNode] like apply() transformed by the given op.

Examples

use nb_tree::{path, prelude::{Tree, Path}};
let mut tree: Tree<usize, String> = Tree::new();
tree.i("/", 0).i("/a", 1).i("/a/b", 2);
let mut iter = tree.iter();
let mut path = Path::new();
let mut e = 0;
path.apply_with(&iter.next().unwrap(), |&c: &&String| (c.clone(), e.clone()));
e += 1;
path.apply_with(&iter.next().unwrap(), |&c: &&String| (c.clone(), e.clone()));
assert_eq!(path, path![("a".into(), 1)]);
e += 1;
path.apply_with(&iter.next().unwrap(), |&c: &&String| (c.clone(), e.clone()));
assert_eq!(path, path![("a".into(), 1), ("b".into(), 2)]);

impl<B> Path<B>

where B: Clone + Eq,

pub fn offshoot_from(&self, branch: Self) -> Path<B>

impl<B> Path<&B>

where B: Clone,

pub fn branches_to_owned(&self) -> Path<B>

Trait Implementations

impl<B: Clone> Clone for Path<B>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Debug> Debug for Path<B>

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

Formats the value using the given formatter.

impl<B> Default for Path<B>

fn default() -> Self

Returns the “default value” for a type.

impl<B: Display> Display for Path<B>

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

Formats the value using the given formatter.

impl<B> From<&str> for Path<B>

where B: FromStr, <B as FromStr>::Err: Dbg,

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<A: Into<B>, B> From<Vec<A>> for Path<B>

fn from(value: Vec<A>) -> Self

Converts to this type from the input type.

impl<B> FromIterator<B> for Path<B>

fn from_iter<T: IntoIterator<Item = B>>(iter: T) -> Self

Creates a value from an iterator.

impl<B: FromStr> FromStr for Path<B>

type Err = ParsePathError<<B as FromStr>::Err>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<B: Hash> Hash for Path<B>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<N, B> Index<&Path<B>> for Tree<N, B>

where B: Eq + Hash + Clone,

type Output = N

The returned type after indexing.

fn index(&self, index: &Path<B>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<B> Index<usize> for Path<B>

type Output = B

The returned type after indexing.

fn index(&self, index: PathIDX) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<B> IndexMut<usize> for Path<B>

fn index_mut(&mut self, index: PathIDX) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, B> IntoIterator for &'a Path<B>

type Item = &'a B

The type of the elements being iterated over.

type IntoIter = Iter<'a, B>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, B> IntoIterator for &'a mut Path<B>

type Item = &'a mut B

The type of the elements being iterated over.

type IntoIter = IterMut<'a, B>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<B> IntoIterator for Path<B>

type Item = B

The type of the elements being iterated over.

type IntoIter = IntoIter<B>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<B: Ord> Ord for Path<B>

fn cmp(&self, other: &Path<B>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<B: PartialEq> PartialEq for Path<B>

fn eq(&self, other: &Path<B>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<B: PartialOrd> PartialOrd for Path<B>

fn partial_cmp(&self, other: &Path<B>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<B: Eq> Eq for Path<B>

impl<B> StructuralPartialEq for Path<B>