Struct rando::RandIter [] [src]

pub struct RandIter<'coll, Collection: ?Sized, Mem = SmallVec<[<Collection as HasMapData>::Key; 32]>, Rng = ThreadRng> where
    Collection: 'coll + Get + Len + HasMapData,
    Mem: Memory<Collection::Key>,
    Rng: Rng
{ /* fields omitted */ }

An iterator over the items in a collection, in random order.

This struct is created by the rand_iter method of the Rando trait, which this library implements for some common collection types.

Methods

impl<'coll, Collection: ?Sized, Mem, Rng> RandIter<'coll, Collection, Mem, Rng> where
    Collection: 'coll + Get + Len + HasMapData,
    Mem: Memory<Collection::Key>,
    Rng: Rng
[src]

Important traits for RandIter<'coll, Collection, Mem, Rng>
[src]

Sets the random number generator for the RandIter.

The random number generator must implement the Rng trait from the rand crate.

The random number generator defaults to that returned by rand::thread_rng.

Examples

let primes = [2, 3, 5, 7, 11];

let other_rng = rand::StdRng::from_rng(rand::EntropyRng::new())?;

assert_eq_up_to_order(
    primes.rand_iter(),
    primes.rand_iter().with_rng(other_rng),
);

Important traits for RandIter<'coll, Collection, Mem, Rng>
[src]

Sets the type of memory buffer for the RandIter.

The memory buffer is a data-structure in which this RandIter will store values representing the indices or other keys of the items that it has already yielded. To be such a memory buffer, a type must implement the Memory trait. This library implements this trait for a few types:

  • Servo's SmallVec — The default type of memory buffer is a SmallVec capable of holding DEFAULT_MEM_LEN entries without allocation, and unbounded entries with allocation.

  • The standard Vec — This kind of memory buffer may be more appropriate than the default for iterating over a collection strongly expected to contain more than DEFAULT_MEM_LEN entries.

  • The standard BTreeSet — This kind of memory buffer may be more appropriate than the default for iterating over a large collection; specifically, one large enough that performing linear search on an unsorted list of its keys becomes more expensive than keeping those keys in a sorted BTreeSet and performing binary search on this sorted data-structure.

Examples

let primes = [2, 3, 5, 7, 11];

assert_eq_up_to_order(
    primes.rand_iter(),
    primes.rand_iter().with_memory::<SmallVec<[_; DEFAULT_MEM_LEN * 2]>>(),
);

assert_eq_up_to_order(
    primes.rand_iter(),
    primes.rand_iter().with_memory::<Vec<_>>(),
);

assert_eq_up_to_order(
    primes.rand_iter(),
    primes.rand_iter().with_memory::<BTreeSet<_>>(),
);

Trait Implementations

impl<'coll, Collection: Clone + ?Sized, Mem: Clone, Rng: Clone> Clone for RandIter<'coll, Collection, Mem, Rng> where
    Collection: 'coll + Get + Len + HasMapData,
    Mem: Memory<Collection::Key>,
    Rng: Rng
[src]

Important traits for RandIter<'coll, Collection, Mem, Rng>
[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl<'coll, Collection: Debug + ?Sized, Mem: Debug, Rng: Debug> Debug for RandIter<'coll, Collection, Mem, Rng> where
    Collection: 'coll + Get + Len + HasMapData,
    Mem: Memory<Collection::Key>,
    Rng: Rng
[src]

[src]

Formats the value using the given formatter. Read more

impl<'coll, Collection: ?Sized, Mem, Rng> Iterator for RandIter<'coll, Collection, Mem, Rng> where
    Collection: Get + Len + HasMapData<Key = usize>,
    Mem: Memory<Collection::Key>,
    Rng: Rng
[src]

The type of the elements being iterated over.

[src]

Advances the iterator and returns the next value. Read more

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

Consumes the iterator, returning the last element. Read more

1.0.0
[src]

Returns the nth element of the iterator. Read more

[src]

🔬 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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

1.21.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

Creates an iterator that both filters and maps. Read more

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

[src]

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

Creates an iterator that flattens nested structure. Read more

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

Borrows an iterator, rather than consuming it. Read more

1.0.0
[src]

Transforms an iterator into a collection. Read more

1.0.0
[src]

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

[src]

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

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

[src]

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

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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

Returns the maximum element of an iterator. Read more

1.0.0
[src]

Returns the minimum element of an iterator. Read more

1.6.0
[src]

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

1.15.0
[src]

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

1.6.0
[src]

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

1.15.0
[src]

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

1.0.0
[src]

Reverses an iterator's direction. Read more

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

Repeats an iterator endlessly. Read more

1.11.0
[src]

Sums the elements of an iterator. Read more

1.11.0
[src]

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

1.5.0
[src]

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

1.5.0
[src]

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

1.5.0
[src]

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

1.5.0
[src]

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

1.5.0
[src]

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

1.5.0
[src]

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

1.5.0
[src]

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

1.5.0
[src]

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

Auto Trait Implementations

impl<'coll, Collection: ?Sized, Mem, Rng> Send for RandIter<'coll, Collection, Mem, Rng> where
    Collection: Sync,
    Mem: Send,
    Rng: Send

impl<'coll, Collection: ?Sized, Mem, Rng> Sync for RandIter<'coll, Collection, Mem, Rng> where
    Collection: Sync,
    Mem: Sync,
    Rng: Sync