Struct nb_tree::prelude::Path

pub struct Path<B: Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> { /* 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::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 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("/a/c/e", 5)
    .i("/b/f", 6);
//    .i(path_f, 6);

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

// Use paths to remove data
//tree.remove_sub_tree()
//assert

Implementations

impl<B: Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> Path<B>

pub fn new() -> Self

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

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

pub fn push_leaf(&mut self, value: B)

pub fn push_root(&mut self, value: B)

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

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

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

Trait Implementations

impl<B: Clone + Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> Clone for Path<B>

fn clone(&self) -> Path<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug + Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> Debug for Path<B>

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

Formats the value using the given formatter.

impl<B: Default + Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> Default for Path<B>

fn default() -> Path<B>

Returns the “default value” for a type.

impl<B: Clone + Default + Display + PartialEq + Eq + PartialOrd + Ord + Hash> Display for Path<B>

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

Formats the value using the given formatter.

impl<B: Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash + FromStr> From<&str> for Path<B>

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<B: Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> From<Vec<B>> for Path<B>

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

Converts to this type from the input type.

impl<B: Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> FromIterator<B> for Path<B>

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

Creates a value from an iterator.

impl<B: Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash + FromStr> FromStr for Path<B>

type Err = ParsePathError

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 + Clone + Default + PartialEq + Eq + PartialOrd + Ord + 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 N: Debug + PartialEq, B: Clone + Debug + Default + PartialEq + Eq + PartialOrd + Ord + Hash,

type Output = N

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<B: Clone + Default + Ord + Hash> 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 + Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<B: PartialEq + Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> PartialEq for Path<B>

fn eq(&self, other: &Path<B>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<B: PartialOrd + Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<B: Eq + Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> Eq for Path<B>

impl<B: Clone + Default + PartialEq + Eq + PartialOrd + Ord + Hash> StructuralPartialEq for Path<B>