Struct fama::Pipeline

pub struct Pipeline<T: Send + Sync + 'static> { /* private fields */ }

The pipes manager

Implementations

impl<T: Clone + Send + Sync + 'static> Pipeline<T>

pub fn pass(content: T) -> Self

Accepts the pipeline content/input. This is the beginning of the pipeline

pub async fn through_fn<H, Args, O>(self, handler: H) -> Selfwhere H: PipeFnHandler<Args, O>, Args: Injectable + 'static,

Accepts a closure or function as a pipe. The closure can accept zero or more arguments. Unlike a struct pipe, a closure does not have to use a tuple for multiple arguments. Arguments can be up to 17

pub async fn next_fn<H, Args>(self, handler: H) -> Selfwhere H: PipeFnHandler<Args, bool>, Args: Injectable + 'static,

Accepts a closure or function as a pipe. The closure can accept zero or more arguments. Unlike a struct pipe, a closure does not have to use a tuple for multiple arguments. Arguments can be up to 17 Closure must return a boolean. False will stop the pipe flow

pub async fn store_fn<H, Args, O: Clone + Send + Sync + 'static>( self, handler: H ) -> Selfwhere H: PipeFnHandler<Args, O>, Args: Injectable + 'static,

Stores the result from the pipe handler

pub async fn some_fn<H, Args, O: Clone + Send + Sync + 'static>( self, handler: H ) -> Selfwhere H: PipeFnHandler<Args, Option<O>>, Args: Injectable + 'static,

pub async fn ok_fn<H, Args, O: Clone + Send + Sync + 'static, E: Clone + Send + Sync + 'static>( self, handler: H ) -> Selfwhere H: PipeFnHandler<Args, Result<O, E>>, Args: Injectable + 'static,

pub async fn through<H, Args, O>(self, handler: H) -> Selfwhere H: FamaPipe<Args, O>, Args: Injectable + 'static,

Accepts an instance of a struct that implements fama::FamaPipe The returned result will be store for the next pipe handlers

pub async fn next<H, Args>(self, handler: H) -> Selfwhere H: FamaPipe<Args, bool>, Args: Injectable + 'static,

Accepts an instance of a struct that implements fama::FamaPipe Must return a boolean. False will halt the flow

pub async fn store<H, Args, O: Clone + Send + Sync + 'static>( self, handler: H ) -> Selfwhere H: FamaPipe<Args, O>, Args: Injectable + 'static,

pub async fn some<H, Args, O: Clone + Send + Sync + 'static>( self, handler: H ) -> Selfwhere H: FamaPipe<Args, Option<O>>, Args: Injectable + 'static,

pub async fn ok<H, Args, O: Clone + Send + Sync + 'static, E: Clone + Send + Sync + 'static>( self, handler: H ) -> Selfwhere H: FamaPipe<Args, Result<O, E>>, Args: Injectable + 'static,

pub fn deliver(&self) -> T

Returns the passed variable

pub fn try_to_deliver(&self) -> Option<T>

Returns the passed variable wrapped in an Option<T>

pub fn deliver_as<R: Clone + 'static>(&self) -> R

Returns a different type that may have been set by one of the pipes

pub fn try_deliver_as<R: Clone + 'static>(&self) -> Option<R>

Returns a different type that may have been set by one of the pipes. The returned type will be wrapped in an Option<T>

pub fn confirm(&self) -> bool

Returns true if the content went through all the registered pipes