Struct Min

pub struct Min<Item> { /* private fields */ }

The Min type uses the std::cmp::PartialOrd trait to contain only the smallest iterated value.

Example:

use autofolder::*;

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

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

// `eval` does the same as `reduce`:
min.eval(2);

// We can then peek at the running output:
println!("Partial min is {:?}", min.as_ref());

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

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

Implementations

impl<Item> Min<Item>

pub fn new(initial: Item) -> Self

Creates a new $name with the provided initial value.

pub fn into_inner(self) -> Option<Item>

Deconstruct self and return the inner value.

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

Returns a reference to the inner value, if there is one.

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

where Item: PartialOrd,

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

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

where Item: PartialOrd + Clone,

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

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

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

where Item: PartialOrd,

Alias for [$name::reduce]

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

where Item: PartialOrd + Clone,

Alias for [$name::reduce_ref]

Trait Implementations

impl<Item: Clone> Clone for Min<Item>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Item: Debug> Debug for Min<Item>

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

Formats the value using the given formatter.

impl<Item> Default for Min<Item>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, Item> Extend<&'a Item> for Min<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 Min<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 Min<Item>

fn from(item: Item) -> Self

Converts to this type from the input type.

impl<'a, Item> FromIterator<&'a Item> for Min<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 Min<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 Min<Item>