Struct flat_tree::Iterator[][src]

pub struct Iterator { /* fields omitted */ }

Iterator over a flat-tree.

Methods

impl Iterator
[src]
[]

[]

Create a new iterator.

Examples

use flat_tree::Iterator;
assert_eq!(Iterator::new(0).take(3).collect::<Vec<usize>>(), [2, 4, 6]);

[]

Get the current index.

[]

Get the current offset.

[]

Seek to a position in the iterator.

Examples

let mut iter = flat_tree::Iterator::new(0);
iter.seek(4);
assert_eq!(iter.next(), Some(6));
iter.seek(2);
assert_eq!(iter.next(), Some(4));

[]

Check if the position of the iterator is currently on a left node.

Examples

assert_eq!(flat_tree::Iterator::new(0).is_left(), true);
assert_eq!(flat_tree::Iterator::new(2).is_left(), false);
assert_eq!(flat_tree::Iterator::new(1).is_left(), true);

[]

Check if the position of the iterator is currently on a right node.

Examples

assert_eq!(flat_tree::Iterator::new(0).is_right(), false);
assert_eq!(flat_tree::Iterator::new(2).is_right(), true);
assert_eq!(flat_tree::Iterator::new(1).is_right(), false);

[]

Move the cursor and get the previous item from the current position.

Examples

let mut iter = flat_tree::Iterator::new(6);
assert_eq!(iter.prev(), 4);
assert_eq!(iter.prev(), 2);
assert_eq!(iter.prev(), 0);

[]

Get the sibling for the current position and move the cursor.

Examples

assert_eq!(flat_tree::Iterator::new(0).sibling(), 2);
assert_eq!(flat_tree::Iterator::new(1).sibling(), 5);
assert_eq!(flat_tree::Iterator::new(4).sibling(), 6);

[]

Get the parent for the current position and move the cursor.

Examples

assert_eq!(flat_tree::Iterator::new(0).parent(), 1);
assert_eq!(flat_tree::Iterator::new(1).parent(), 3);
assert_eq!(flat_tree::Iterator::new(4).parent(), 5);

[]

Get the left_span for the current position and move the cursor.

Examples

assert_eq!(flat_tree::Iterator::new(0).left_span(), 0);
assert_eq!(flat_tree::Iterator::new(1).left_span(), 0);
assert_eq!(flat_tree::Iterator::new(3).left_span(), 0);
assert_eq!(flat_tree::Iterator::new(23).left_span(), 16);
assert_eq!(flat_tree::Iterator::new(27).left_span(), 24);

[]

Get the right_span for the current position and move the cursor.

Examples

assert_eq!(flat_tree::Iterator::new(0).right_span(), 0);
assert_eq!(flat_tree::Iterator::new(1).right_span(), 2);
assert_eq!(flat_tree::Iterator::new(3).right_span(), 6);
assert_eq!(flat_tree::Iterator::new(23).right_span(), 30);
assert_eq!(flat_tree::Iterator::new(27).right_span(), 30);

[]

Get the left_child for the current position and move the cursor.

Examples

assert_eq!(flat_tree::Iterator::new(1).left_child(), 0);
assert_eq!(flat_tree::Iterator::new(3).left_child(), 1);
assert_eq!(flat_tree::Iterator::new(7).left_child(), 3);

[]

Get the right_child for the current position and move the cursor.

Examples

assert_eq!(flat_tree::Iterator::new(1).right_child(), 2);
assert_eq!(flat_tree::Iterator::new(3).right_child(), 5);
assert_eq!(flat_tree::Iterator::new(7).right_child(), 11);

Trait Implementations

impl Debug for Iterator
[src]
[+]

[]

Formats the value using the given formatter. Read more

impl Iterator for Iterator
[src]
[+]

The type of the elements being iterated over.

[]

Advances the iterator and returns the next value. Read more

[]

Returns the bounds on the remaining length of the iterator. Read more

[]

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

[]

Consumes the iterator, returning the last element. Read more

[]

Returns the nth element of the iterator. Read more

[]

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

unstable replacement of Range::step_by

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

[]

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

[]

'Zips up' two iterators into a single iterator of pairs. Read more

[]

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

[]

Calls a closure on each element of an iterator. Read more

[]

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

[]

Creates an iterator that both filters and maps. Read more

[]

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

[]

Creates an iterator which can use peek to look at the next element of the iterator without consuming it. Read more

[]

Creates an iterator that [skip]s elements based on a predicate. Read more

[]

Creates an iterator that yields elements based on a predicate. Read more

[]

Creates an iterator that skips the first n elements. Read more

[]

Creates an iterator that yields its first n elements. Read more

[]

An iterator adaptor similar to [fold] that holds internal state and produces a new iterator. Read more

[]

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

[]

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

Creates an iterator that flattens nested structure. Read more

[]

Creates an iterator which ends after the first [None]. Read more

[]

Do something with each element of an iterator, passing the value on. Read more

[]

Borrows an iterator, rather than consuming it. Read more

[]

Transforms an iterator into a collection. Read more

[]

Consumes an iterator, creating two collections from it. Read more

[]

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

[]

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

[]

An iterator method that applies a function, producing a single, final value. Read more

[]

Tests if every element of the iterator matches a predicate. Read more

[]

Tests if any element of the iterator matches a predicate. Read more

[]

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

[]

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

unstable new API

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

[]

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

[]

Searches for an element in an iterator from the right, returning its index. Read more

[]

Returns the maximum element of an iterator. Read more

[]

Returns the minimum element of an iterator. Read more

[]

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

[]

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

[]

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

[]

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

[]

Reverses an iterator's direction. Read more

[]

Converts an iterator of pairs into a pair of containers. Read more

[]

Creates an iterator which [clone]s all of its elements. Read more

[]

Repeats an iterator endlessly. Read more

[]

Sums the elements of an iterator. Read more

[]

Iterates over the entire iterator, multiplying all the elements Read more

[]

Lexicographically compares the elements of this Iterator with those of another. Read more

[]

Lexicographically compares the elements of this Iterator with those of another. Read more

[]

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

[]

Determines if the elements of this Iterator are unequal to those of another. Read more

[]

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

[]

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

[]

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

[]

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

impl Default for Iterator
[src]
[+]

[]

Returns the "default value" for a type. Read more

Auto Trait Implementations

impl Send for Iterator

impl Sync for Iterator