iterpipes 0.2.0

use crate::{Pipe, ResetablePipe};
use std::marker::PhantomData;

/// A pipe that connects two other pipes together.
///
/// The input item of this connector is the input item of `P0` and its output item is the output item of `P1`. It calculates the output item of `P0` and feeds it directly into `P1`.
///
/// Obviously, the output item of `P0` has to match the input item of `P1`.
///
/// For more information, please see [the documentation of the `connect` method](trait.Pipe.html#method.connect).
pub struct Connector<P0, P1>
where
    P0: Pipe,
    P1: Pipe<InputItem = P0::OutputItem>,
{
    pipe0: P0,
    pipe1: P1,
}

impl<P0, P1> Connector<P0, P1>
where
    P0: Pipe,
    P1: Pipe<InputItem = P0::OutputItem>,
{
    /// Create a new connector with the two pipes.
    pub fn new(pipe0: P0, pipe1: P1) -> Self {
        Connector { pipe0, pipe1 }
    }
}

impl<P0, P1> Pipe for Connector<P0, P1>
where
    P0: Pipe,
    P1: Pipe<InputItem = P0::OutputItem>,
{
    type InputItem = P0::InputItem;
    type OutputItem = P1::OutputItem;

    fn next(&mut self, input: Self::InputItem) -> Self::OutputItem {
        self.pipe1.next(self.pipe0.next(input))
    }
}

impl<P0, P1> ResetablePipe for Connector<P0, P1>
where
    P0: ResetablePipe,
    P1: ResetablePipe<InputItem = P0::OutputItem>,
{
    fn reset(&mut self) {
        self.pipe0.reset();
        self.pipe1.reset();
    }
}

/// A pipe that bypasses the effects of an internal pipe.
///
/// For more information, please see [the documentation of the `bypass` method](trait.Pipe.html#method.bypass).
pub struct Bypass<P>
where
    P: Pipe,
    P::InputItem: Clone,
{
    pipe: P,
}

impl<P> Bypass<P>
where
    P: Pipe,
    P::InputItem: Clone,
{
    /// Create a new bypassed pipe.
    pub fn new(pipe: P) -> Self {
        Self { pipe }
    }
}

impl<P> Pipe for Bypass<P>
where
    P: Pipe,
    P::InputItem: Clone,
{
    type InputItem = P::InputItem;
    type OutputItem = (P::InputItem, P::OutputItem);

    fn next(&mut self, input: P::InputItem) -> (P::InputItem, P::OutputItem) {
        (input.clone(), self.pipe.next(input))
    }
}

impl<P> ResetablePipe for Bypass<P>
where
    P: ResetablePipe,
    P::InputItem: Clone,
{
    fn reset(&mut self) {
        self.pipe.reset();
    }
}

/// A "lazily" create pipe with a mutable state.
///
/// This pipe's behavior is defined by a callable object, for example a lambda expression, and can therefore be "lazily" created inline.
///
/// Since callable objects with mutable state can not be reseted, `reset` will panic if it's called.
///
/// # Example
///
/// ```
/// use iterpipes::*;
///
/// let mut counter: u8 = 0;
/// let mut pipe = LazyMut::new(|i: u8| {
///     counter += 1;
///     i*counter
/// });
///
/// assert_eq!(1, pipe.next(1));
/// assert_eq!(4, pipe.next(2));
/// ```
pub struct LazyMut<I, O, F>
where
    F: FnMut(I) -> O,
{
    function: F,
    input: PhantomData<I>,
    output: PhantomData<O>,
}

impl<I, O, F> LazyMut<I, O, F>
where
    F: FnMut(I) -> O,
{
    /// Create a new lazy pipe.
    pub fn new(function: F) -> Self {
        LazyMut {
            function,
            input: PhantomData,
            output: PhantomData,
        }
    }
}

impl<I, O, F> Pipe for LazyMut<I, O, F>
where
    F: FnMut(I) -> O,
{
    type InputItem = I;
    type OutputItem = O;

    fn next(&mut self, input: I) -> O {
        (self.function)(input)
    }
}

/// A "lazily" create pipe with an immutable state.
///
/// This pipe's behavior is defined by a callable object, for example a lambda expression, and can therefore be "lazily" created inline.
///
/// Since callable objects with an immutable state don't need to be reseted, `reset` is a no-op.
///
/// # Example
///
/// ```
/// use iterpipes::*;
///
/// let mut counter: u8 = 2;
/// let mut pipe = Lazy::new(|i: u8| {
///     i*counter
/// });
///
/// assert_eq!(2, pipe.next(1));
/// assert_eq!(4, pipe.next(2));
/// ```
pub struct Lazy<I, O, F>
where
    F: Fn(I) -> O,
{
    function: F,
    input: PhantomData<I>,
    output: PhantomData<O>,
}

impl<I, O, F> Lazy<I, O, F>
where
    F: Fn(I) -> O,
{
    /// Create a new lazy pipe.
    pub fn new(function: F) -> Self {
        Lazy {
            function,
            input: PhantomData,
            output: PhantomData,
        }
    }
}

impl<I, O, F> Pipe for Lazy<I, O, F>
where
    F: Fn(I) -> O,
{
    type InputItem = I;
    type OutputItem = O;

    fn next(&mut self, input: I) -> O {
        (self.function)(input)
    }
}

impl<I, O, F> ResetablePipe for Lazy<I, O, F>
where
    F: Fn(I) -> O,
{
    fn reset(&mut self) {}
}

/// A pipe that wraps another pipe's IO in an `Option`.
///
/// For more information, please see [the documentation of the `optional` method](trait.Pipe.html#method.optional).
pub struct Optional<P>
where
    P: Pipe,
{
    pipe: P,
}

impl<P: Pipe> Optional<P> {
    /// Create a new optional pipe.
    pub fn new(pipe: P) -> Self {
        Optional { pipe }
    }
}

impl<P> Pipe for Optional<P>
where
    P: Pipe,
{
    type InputItem = Option<P::InputItem>;
    type OutputItem = Option<P::OutputItem>;

    fn next(&mut self, item: Option<P::InputItem>) -> Option<P::OutputItem> {
        item.map(|item| self.pipe.next(item))
    }
}

impl<P> ResetablePipe for Optional<P>
where
    P: ResetablePipe,
{
    fn reset(&mut self) {
        self.pipe.reset();
    }
}

/// A pipe that enumerates the output items of another pipe.
///
/// The inputs of this pipe are the same as the wrapped ones, but it's output item is a tuple of an index and the wrapped pipe's output. The index starts with zero and counts up for every produces output item.
///
/// For more information, please see [the documentation of the `enumerate` method](trait.Pipe.html#method.enumerate).
pub struct Enumerate<P>
where
    P: Pipe,
{
    pipe: P,
    progress: usize,
}

impl<P: Pipe> Enumerate<P> {
    /// Create a new enumerating pipe.
    pub fn new(pipe: P) -> Self {
        Enumerate { pipe, progress: 0 }
    }
}

impl<P: Pipe> Pipe for Enumerate<P> {
    type InputItem = P::InputItem;
    type OutputItem = (usize, P::OutputItem);

    fn next(&mut self, item: P::InputItem) -> (usize, P::OutputItem) {
        let next_item = self.pipe.next(item);
        let index = self.progress;
        self.progress += 1;
        (index, next_item)
    }
}

impl<P: ResetablePipe> ResetablePipe for Enumerate<P> {
    fn reset(&mut self) {
        self.pipe.reset();
        self.progress = 0;
    }
}

/// A continous counter.
///
/// This pipe has an counter and a delta value. Every time `next` is called, the current counter value is returned and the delta is added to the counter. It also knows it's starting value and can therefore be reseted.
///
/// # Example
///
/// ```
/// use iterpipes::*;
///
/// let mut counter: Counter<u8> = Counter::new(1, 2);
/// assert_eq!(1, counter.next(()));
/// assert_eq!(3, counter.next(()));
/// ```
pub struct Counter<T>
where
    T: std::ops::AddAssign<T> + Copy,
{
    starting_value: T,
    delta: T,
    counter: T,
}

impl<T> Counter<T>
where
    T: std::ops::AddAssign<T> + Copy,
{
    pub fn new(starting_value: T, delta: T) -> Self {
        Self {
            starting_value,
            delta,
            counter: starting_value,
        }
    }
}

impl<T> Pipe for Counter<T>
where
    T: std::ops::AddAssign<T> + Copy,
{
    type InputItem = ();
    type OutputItem = T;

    fn next(&mut self, _: ()) -> T {
        let item = self.counter;
        self.counter += self.delta;
        item
    }
}

impl<T> ResetablePipe for Counter<T>
where
    T: std::ops::AddAssign<T> + Copy,
{
    fn reset(&mut self) {
        self.counter = self.starting_value;
    }
}

/// A simple forwarding pipe.
///
/// This pipe takes an input item and immediately emits it again.
///
/// # Example
///
/// ```
/// use iterpipes::*;
///
/// let mut ditto: Ditto<u8> = Ditto::default();
///
/// assert_eq!(ditto.next(42), 42);
/// ```
pub struct Ditto<T> {
    item: PhantomData<T>,
}

impl<T> Default for Ditto<T> {
    fn default() -> Self {
        Self { item: PhantomData }
    }
}

impl<T> Pipe for Ditto<T> {
    type InputItem = T;
    type OutputItem = T;

    fn next(&mut self, item: T) -> T {
        item
    }
}

impl<T> ResetablePipe for Ditto<T> {
    fn reset(&mut self) {}
}