Struct Nodes

pub struct Nodes<Q, T>
where
    Q: PartialEq + Eq + Clone,
    T: PartialEq + Eq + Clone,
{ /* private fields */ }

An iterator over the nodes in a tree.

This struct represents an iterator over the nodes in a tree. The iterator is created by calling the iter method on the tree. The iterator yields the nodes in the tree in the order that they were added to the tree.

Type Parameters

• Q - The type of the unique id of the node.
• T - The type of the value of the node.

Implementations

impl<Q, T> Nodes<Q, T>

where Q: PartialEq + Eq + Clone, T: PartialEq + Eq + Clone,

pub fn new(nodes: Vec<Node<Q, T>>) -> Self

Create a new iterator over the nodes in a tree.

This method creates a new iterator over the nodes in a tree.

Arguments

• nodes - The nodes in the tree.

Returns

A new iterator over the nodes in a tree.

Example

let nodes = Nodes::new(vec![Node::new(1, Some(2))]);

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

Get an iterator over the nodes in the tree.

This method returns an iterator over the nodes in the tree.

Returns

An iterator over the nodes in the tree.

Example

let nodes = Nodes::new(vec![Node::new(1, Some(2))]);

for node in nodes.iter() {
    // Do something with the node.
}

pub fn len(&self) -> usize

Get the number of nodes in the tree.

This method returns the number of nodes in the tree.

Returns

The number of nodes in the tree.

Example

let nodes = Nodes::new(vec![Node::new(1, Some(2))]);
assert_eq!(nodes.len(), 1);

pub fn is_empty(&self) -> bool

Check if the tree is empty.

This method checks if the tree is empty.

Returns

true if the tree is empty, false otherwise.

pub fn get(&self, index: usize) -> Option<&Node<Q, T>>

Get a node at the specified index.

This method returns a node at the specified index.

Arguments

• index - The index of the node to get.

Returns

The node at the specified index.

Example

let nodes = Nodes::new(vec![Node::new(1, Some(2))]);
assert_eq!(nodes.get(0).unwrap().get_node_id().unwrap(), 1);

pub fn get_by_node_id(&self, node_id: &Q) -> Option<&Node<Q, T>>

Get a node by the node id.

This method returns a node by the node id.

Arguments

• node_id - The node id of the node to get.

Returns

The node with the specified node id.

Example

let nodes = Nodes::new(vec![Node::new(1, Some(2))]);
assert_eq!(nodes.get_by_node_id(&1).unwrap().get_node_id().unwrap(), 1);

pub fn push(&mut self, node: Node<Q, T>)

Push a node to the nodes list.

This method pushes a node to the nodes list.

Arguments

• node - The node to push.

Example

let mut nodes = Nodes::new(vec![Node::new(1, Some(2))]);
nodes.push(Node::new(2, Some(3)));
assert_eq!(nodes.len(), 2);

pub fn remove(&mut self, index: usize) -> Node<Q, T>

Remove a node at the specified index.

This method removes a node at the specified index.

Arguments

• index - The index of the node to remove.

Returns

The removed node.

Example

let mut nodes = Nodes::new(vec![Node::new(1, Some(2))]);
let removed_node = nodes.remove(0);
assert_eq!(removed_node.get_node_id().unwrap(), 1);
assert_eq!(nodes.len(), 0);

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&Node<Q, T>) -> bool,

Retain only the nodes that satisfy the predicate.

This method retains only the nodes that satisfy the predicate. The predicate is a function that takes a node and returns a boolean value. If the predicate returns true, the node is retained. If the predicate returns false, the node is removed. The nodes are retained in the order that they were added to the tree.

Arguments

• f - The predicate function.

Example

let mut nodes = Nodes::new(vec![Node::new(1, Some(2)), Node::new(2, Some(3))]);
nodes.retain(|node| node.get_node_id().expect("Error: Could not fetch the node id.") == 1);
assert_eq!(nodes.len(), 1);

pub fn clear(&mut self)

Clear the nodes list.

This method clears the nodes list.

Example

let mut nodes = Nodes::new(vec![Node::new(1, Some(2)), Node::new(2, Some(3))]);
nodes.clear();
assert_eq!(nodes.len(), 0);

pub fn append(&mut self, other: &mut Self)

Append the nodes from another nodes list.

This method appends the nodes from another nodes list.

Arguments

• other - The other nodes list.

Example

let mut nodes = Nodes::new(vec![Node::new(1, Some(2))]);
let mut other_nodes = Nodes::new(vec![Node::new(2, Some(3))]);
nodes.append(&mut other_nodes);
assert_eq!(nodes.len(), 2);

pub fn append_raw(&mut self, other: &mut Vec<Node<Q, T>>)

Append the nodes from another nodes list.

This method appends the nodes from another nodes list. This method is useful when you want to append the nodes as a raw vector.

Arguments

• other - The other nodes list.

Example

let mut nodes = Nodes::new(vec![Node::new(1, Some(2))]);
let mut other_nodes = vec![Node::new(2, Some(3))];
nodes.append_raw(&mut other_nodes);
assert_eq!(nodes.len(), 2);

pub fn first(&self) -> Option<&Node<Q, T>>

Get the first node in the nodes list.

This method returns the first node in the nodes list.

Returns

The first node in the nodes list.

Example

let nodes = Nodes::new(vec![Node::new(1, Some(2)), Node::new(2, Some(3))]);
assert_eq!(nodes.first().unwrap().get_node_id().unwrap(), 1);

Trait Implementations

impl<Q, T> AsRef<Nodes<Q, T>> for Nodes<Q, T>

where Q: PartialEq + Eq + Clone, T: PartialEq + Eq + Clone,

fn as_ref(&self) -> &Nodes<Q, T>

Get a reference to the nodes list.

impl<Q, T> Clone for Nodes<Q, T>

where Q: PartialEq + Eq + Clone + Clone, T: PartialEq + Eq + Clone + Clone,

fn clone(&self) -> Nodes<Q, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Q, T> Debug for Nodes<Q, T>

where Q: PartialEq + Eq + Clone + Debug, T: PartialEq + Eq + Clone + Debug,

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

Formats the value using the given formatter.

impl<Q, T> Default for Nodes<Q, T>

where Q: PartialEq + Eq + Clone, T: PartialEq + Eq + Clone,

fn default() -> Self

Create an empty nodes list.

impl<Q, T> Display for Nodes<Q, T>

where Q: PartialEq + Eq + Clone + Display, T: PartialEq + Eq + Clone + Display + Default,

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

Display the nodes list.

impl<Q, T> FromIterator<Node<Q, T>> for Nodes<Q, T>

where Q: PartialEq + Eq + Clone, T: PartialEq + Eq + Clone,

fn from_iter<I: IntoIterator<Item = Node<Q, T>>>(iter: I) -> Self

Create a nodes list from an iterator.

impl<Q, T> Hash for Nodes<Q, T>

where Q: PartialEq + Eq + Clone + Hash, T: PartialEq + Eq + Clone + Hash,

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<Q, T> Iterator for Nodes<Q, T>

where Q: PartialEq + Eq + Clone, T: PartialEq + Eq + Clone,

fn next(&mut self) -> Option<Self::Item>

Get the next node in the nodes list.

fn size_hint(&self) -> (usize, Option<usize>)

Get the size hint of the nodes list.

type Item = Node<Q, T>

The type of the elements being iterated over.

fn next_chunk<const N: usize>( &mut self, ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)

Advances the iterator and returns an array containing the next N values.

fn count(self) -> usize

where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

where Self: Sized,

Consumes the iterator, returning the last element.

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

fn step_by(self, step: usize) -> StepBy<Self>

where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs.

fn intersperse(self, separator: Self::Item) -> Intersperse<Self>

where Self: Sized, Self::Item: Clone,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places a copy of separator between adjacent items of the original iterator.

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>

where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places an item generated by separator between adjacent items of the original iterator.

fn map<B, F>(self, f: F) -> Map<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element.

fn for_each<F>(self, f: F)

where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator.

fn filter<P>(self, predicate: P) -> Filter<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate.

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>

where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps.

fn skip(self, n: usize) -> Skip<Self>

where Self: Sized,

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>

where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>

where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>

where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure.

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>

where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows)

Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well.

fn fuse(self) -> Fuse<Self>

where Self: Sized,

Creates an iterator which ends after the first None.

fn inspect<F>(self, f: F) -> Inspect<Self, F>

where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Iterator.

fn collect<B>(self) -> B

where B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection.

fn collect_into<E>(self, collection: &mut E) -> &mut E

where E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)

Collects all the items from an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B)

where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it.

fn is_partitioned<P>(self, predicate: P) -> bool

where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_is_partitioned)

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false.

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R

where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value.

fn try_for_each<F, R>(&mut self, f: F) -> R

where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

fn fold<B, F>(self, init: B, f: F) -> B

where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result.

fn reduce<F>(self, f: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation.

fn try_reduce<R>( &mut self, f: impl FnMut(Self::Item, Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType

where Self: Sized, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce)

Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately.

fn all<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate.

fn find_map<B, F>(&mut self, f: F) -> Option<B>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result.

fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType

where Self: Sized, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find)

Applies function to the elements of iterator and returns the first true result or the first error.

fn position<P>(&mut self, predicate: P) -> Option<usize>

where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function.

fn max_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function.

fn min_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)

where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers.

fn copied<'a, T>(self) -> Copied<Self>

where T: 'a + Copy, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements.

fn cloned<'a, T>(self) -> Cloned<Self>

where T: 'a + Clone, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements.

fn cycle(self) -> Cycle<Self>

where Self: Sized + Clone,

Repeats an iterator endlessly.

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)

Returns an iterator over N elements of the iterator at a time.

fn sum<S>(self) -> S

where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator.

fn product<P>(self) -> P

where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn partial_cmp<I>(self, other: I) -> Option<Ordering>

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned.

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn eq<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another.

fn eq_by<I, F>(self, other: I, eq: F) -> bool

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_order_by)

Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function.

fn ne<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another.

fn lt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

fn is_sorted_by<F>(self, compare: F) -> bool

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

Checks if the elements of this iterator are sorted using the given comparator function.

fn is_sorted_by_key<F, K>(self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

Checks if the elements of this iterator are sorted using the given key extraction function.

impl<Q, T> PartialEq for Nodes<Q, T>

where Q: PartialEq + Eq + Clone + PartialEq, T: PartialEq + Eq + Clone + PartialEq,

fn eq(&self, other: &Nodes<Q, 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<Q, T> Eq for Nodes<Q, T>

where Q: PartialEq + Eq + Clone + Eq, T: PartialEq + Eq + Clone + Eq,

impl<Q, T> StructuralPartialEq for Nodes<Q, T>

where Q: PartialEq + Eq + Clone, T: PartialEq + Eq + Clone,