Struct ppl::pipeline::Pipeline

pub struct Pipeline<TOut, TCollected, TNext>
where
    TOut: Send + 'static,
    TNext: Node<TOut, TCollected> + Send + Sync + 'static,
{ /* private fields */ }

The Pipeline struct represents a pipeline of nodes.

The Pipeline struct is generic over the type of the output of the pipeline and the type of the collected result, is created using the pipeline! macro.

Implementations

impl<TOut, TCollected, TNext> Pipeline<TOut, TCollected, TNext>

where TOut: Send + 'static, TNext: Node<TOut, TCollected> + Send + Sync + 'static,

pub fn new( source: OutNode<TOut, TCollected, TNext> ) -> Pipeline<TOut, TCollected, TNext>

Creates a new Pipeline struct.

Arguments

• source - The first stage of the pipeline.

pub fn start(&mut self)

Starts the pipeline.

This method starts the pipeline by starting the first stage.

Panics

This method panics if the pipeline is empty.

pub fn wait_end(self) -> Option<TCollected>

Waits for the pipeline to finish and collects the result.

This method waits for the pipeline to finish and collects the result.

Panics

This method panics if the pipeline is empty.

pub fn start_and_wait_end(self) -> Option<TCollected>

Start the pipeline and wait for the result. This method will start the pipeline and wait for the result.

Panics

This method panics if the pipeline is empty.

Trait Implementations

impl<TOut, TCollected, TNext> Drop for Pipeline<TOut, TCollected, TNext>

where TOut: Send + 'static, TNext: Node<TOut, TCollected> + Send + Sync + 'static,

fn drop(&mut self)

Drop the pipeline.

This method terminates the pipeline by terminating the first stage. After this the termination is propagated to the next stages and so on.