Struct PathTree 

pub struct PathTree<T>(/* private fields */);

A tree data structure for storing paths without mutation.

Cloning the data structure is inexpensive since each clone only clones a single Arc.

Examples

use pathtree::PathTree;


let path = PathTree::empty();
let path = path.append_segment(7);
let path = path.append_segment(5);
let path = path.prepend_segment(6);
let path = path.prepend_segment(8);

let path_vec: Vec<_> = path.iter().copied().collect();
assert_eq!(path_vec, vec![8, 6, 7, 5]);

let other_path = PathTree::empty();

let other_path = other_path.append_segment(2);
let other_path = other_path.prepend_segment(1);
let other_path = other_path.append_segment(3);
let other_path = other_path.prepend_segment(4);

let full_path = other_path.append(&path);
let full_path_vec: Vec<_> = full_path.iter().copied().collect();
assert_eq!(full_path_vec, vec![4, 1, 2, 3, 8, 6, 7, 5]);

Implementations

impl<T> PathTree<T>

pub fn new(segment: T) -> Self

Creates a new PathTree with a single segment.

pub fn empty() -> Self

Creates an empty PathTree.

pub fn append(&self, other: &PathTree<T>) -> Self

Appends another PathTree to self.

pub fn prepend(&self, other: &PathTree<T>) -> Self

Prepends another PathTree to self.

pub fn append_segment(&self, segment: T) -> Self

Appends a segment to self.

pub fn prepend_segment(&self, segment: T) -> Self

Prepends a segment to self.

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

Creates an iterator over the items in the path.

Trait Implementations

impl<T> Clone for PathTree<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PathTree<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for PathTree<T>

fn default() -> PathTree<T>

Returns the “default value” for a type.

impl<A> FromIterator<A> for PathTree<A>

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

Creates a value from an iterator.

impl<T: Hash> Hash for PathTree<T>

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<'a, T> IntoIterator for &'a PathTree<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for PathTree<T>

fn cmp(&self, other: &PathTree<T>) -> 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<T: PartialEq> PartialEq for PathTree<T>

fn eq(&self, other: &PathTree<T>) -> bool

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

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<T: PartialOrd> PartialOrd for PathTree<T>

fn partial_cmp(&self, other: &PathTree<T>) -> 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<T: Eq> Eq for PathTree<T>

impl<T> StructuralPartialEq for PathTree<T>