Trait Source 

pub trait Source {
    type Item;
    type Error: StageError;

    // Required method
    fn pull(&mut self) -> Result<Option<Self::Item>, Self::Error>;

    // Provided method
    fn close(&mut self) -> Result<(), Self::Error> { ... }
}

Producer at the head of a pipeline.

Required Associated Types

type Item

Type of item produced.

type Error: StageError

Error type the source can return.

Required Methods

fn pull(&mut self) -> Result<Option<Self::Item>, Self::Error>

Pull the next item.

Errors

Returns Err(Self::Error) if the source fails. The driver wraps this in crate::Error::Source.

Ok(None) signals end-of-stream.

Provided Methods

fn close(&mut self) -> Result<(), Self::Error>

Close the source. Default impl does nothing.

Errors

Returns Err(Self::Error) if cleanup fails.

Implementors

impl<F, T, E> Source for FnSource<F, T, E>

where F: FnMut() -> Result<Option<T>, E>, E: StageError,

type Item = T

type Error = E

impl<I> Source for IterSource<I>

where I: Iterator,

type Item = <I as Iterator>::Item

type Error = Infallible

impl<R: Read> Source for ReaderSource<R>

Available on crate feature std only.

type Item = String

type Error = Error

impl<T> Source for ChannelSource<T>

where T: 'static,

Available on crate feature std only.

type Item = T

type Error = Infallible