Struct Optional

pub struct Optional<P>
where
    P: Pipe,
{ /* private fields */ }

A pipe that wraps another pipe’s IO in an Option.

For more information, please see the documentation of the optional method.

Implementations

impl<P: Pipe> Optional<P>

pub fn new(pipe: P) -> Self

Create a new optional pipe.

Trait Implementations

impl<P> Pipe for Optional<P>

where P: Pipe,

type InputItem = Option<<P as Pipe>::InputItem>

The type of input this pipe accepts.

type OutputItem = Option<<P as Pipe>::OutputItem>

The type of output this pipe produces.

fn next(&mut self, item: Option<P::InputItem>) -> Option<P::OutputItem>

Calculate the next output item, based on an input item.

fn bypass(self) -> Bypass<Self>

where Self: Sized, Self::InputItem: Clone,

Create a bypassed version of the pipe.

fn compose(self) -> Composed<Self>

where Self: Sized,

Create a composable pipe.

fn connect<O: Pipe<InputItem = Self::OutputItem>>( self, other: O, ) -> Connector<Self, O>

where Self: Sized,

Connect two pipes.

fn optional(self) -> Optional<Self>

where Self: Sized,

Optionalize the pipe.

fn enumerate(self) -> Enumerate<Self>

where Self: Sized,

Enumerate the output items of a pipe.

fn boxed( self, ) -> Box<dyn Pipe<InputItem = Self::InputItem, OutputItem = Self::OutputItem>>

where Self: Sized + 'static,

Create a boxed trait object of the pipe.

impl<P> ResetablePipe for Optional<P>

where P: ResetablePipe,

fn reset(&mut self)

Reset the state of the pipe.