Trait rayon::iter::plumbing::Folder

pub trait Folder<Item>: Sized {
    type Result;

    // Required methods
    fn consume(self, item: Item) -> Self;
    fn complete(self) -> Self::Result;
    fn full(&self) -> bool;

    // Provided method
    fn consume_iter<I>(self, iter: I) -> Self
       where I: IntoIterator<Item = Item> { ... }
}

The Folder trait encapsulates the standard fold operation. It can be fed many items using the consume method. At the end, once all items have been consumed, it can then be converted (using complete) into a final value.

Required Associated Types

type Result

The type of result that will ultimately be produced by the folder.

Required Methods

fn consume(self, item: Item) -> Self

Consume next item and return new sequential state.

fn complete(self) -> Self::Result

Finish consuming items, produce final result.

fn full(&self) -> bool

Hint whether this Folder would like to stop processing further items, e.g. if a search has been completed.

Provided Methods

fn consume_iter<I>(self, iter: I) -> Self

where I: IntoIterator<Item = Item>,

Consume items from the iterator until full, and return new sequential state.

This method is optional. The default simply iterates over iter, invoking consume and checking after each iteration whether full returns false.

The main reason to override it is if you can provide a more specialized, efficient implementation.

Object Safety

This trait is not object safe.

Implementors