Enum MinMax

pub enum MinMax<Item> {
    None,
    Single(Item),
    Both(Item, Item),
}

The MinMax type uses the std::cmp::PartialOrd trait to contain both the smallest and largest iterated values.

Example:

use autofolder::*;

// Create an autofolder that collects the min+max usize.
let mut minmax = MinMax::<usize>::default();

// We can "reduce-in" individual items.
// (note: as this is the first value, we incorporate it
//  without calling the trait function)
minmax.reduce(3);

// Minmax fills up `min` first, so at this moment we can see that
// min is all we have:
println!("Partial minmax is {:?}", minmax.as_ref());

// `eval` does the same as `reduce`, and in this case sets
// min=2 and max=3:
minmax.eval(2);

// We can now peek at the running output as a single `Option`:
println!("Partial minmax is {:?}", minmax.as_ref());

// And still keep on folding by processing whole iterators:
minmax.extend((1..=5));

// And finally consume the autofolder to get the final output value:
let (min, max) = minmax.to_inner().unwrap();
println!("Final min is {}, max is {}", min, max);

Variants

None

Empty; no item evaluated.

Single(Item)

Single item evaluated.

Both(Item, Item)

Two or more items evaluated - min and max values.

Implementations

impl<Item> MinMax<Item>

pub fn new(initial: Item) -> Self

Creates a new MinMax with the provided initial values.

pub fn to_inner(self) -> Option<(Item, Item)>

where Item: Clone,

Deconstruct self and return the inner values that were found.

pub fn as_ref(&self) -> Option<(&Item, &Item)>

Returns a reference to the inner values, if they exist.

pub fn min_as_ref(&self) -> Option<&Item>

Returns a reference to the min inner values, if it exist.

pub fn max_as_ref(&self) -> Option<&Item>

Returns a reference to the max inner values, if it exist.

pub fn reduce(&mut self, item: Item)

where Item: PartialOrd,

Replaces a current value with the new one if the new one is greater/smaller.

When we have a single value, min is always filled up first, and then swapped with max if necessary.

pub fn reduce_ref(&mut self, item: &Item)

where Item: PartialOrd + Clone,

Replaces a current value with the one behind the ref if it is greater/smaller.

When we have a single value, min is always filled up first, and then swapped with max if necessary.

This function requires the Clone trait, but uses it only if necessary.

pub fn eval(&mut self, item: Item)

where Item: PartialOrd,

Alias for MinMax::reduce

pub fn eval_ref(&mut self, item: &Item)

where Item: PartialOrd + Clone,

Alias for MinMax::reduce_ref

Trait Implementations

impl<Item: Clone> Clone for MinMax<Item>

fn clone(&self) -> MinMax<Item>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Item: Debug> Debug for MinMax<Item>

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

Formats the value using the given formatter.

impl<Item> Default for MinMax<Item>

fn default() -> MinMax<Item>

Returns the “default value” for a type.

impl<'a, Item> Extend<&'a Item> for MinMax<Item>

where Item: PartialOrd + Clone,

fn extend<It: IntoIterator<Item = &'a Item>>(&mut self, iter: It)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<Item> Extend<Item> for MinMax<Item>

where Item: PartialOrd,

fn extend<It: IntoIterator<Item = Item>>(&mut self, iter: It)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<Item> From<Item> for MinMax<Item>

fn from(item: Item) -> Self

Converts to this type from the input type.

impl<'a, Item> FromIterator<&'a Item> for MinMax<Item>

where Item: PartialOrd + Clone,

fn from_iter<It: IntoIterator<Item = &'a Item>>(iter: It) -> Self

Creates a value from an iterator.

impl<Item> FromIterator<Item> for MinMax<Item>

where Item: PartialOrd,

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

Creates a value from an iterator.

impl<Item: Copy> Copy for MinMax<Item>