Skip to main content

PipelineBuilder

Struct PipelineBuilder 

Source
pub struct PipelineBuilder<T: Clone + Send + Sync + 'static> { /* private fields */ }
Expand description

PipelineBuilder provides flexibility and extensibility to your pipelines

Pipes/function can be appended to your type pipeline from other places in your code or even across crates.


#[derive(Default, Clone)]
struct MeaningOfLife(i32);



#[tokio::main]
async fn main() {

   let builder = PipelineBuilder::<MeaningOfLife>::new();

   builder.register(|pipeline| {
      Box::pin(async {
        pipeline.store_fn(|mut instance: MeaningOfLife| async {
            instance.0 = 42;
           instance
        }).await
     })
   }).await;
 
   let life = builder.build(MeaningOfLife::default()).await.deliver().await;
   assert_eq!(life.0, 42);
}

You can implement the PipelineBuilderTrait for your type as well


#[derive(Default, Clone)]
struct MeaningOfLife(i32);


#[fama::async_trait]
impl PipelineBuilderTrait for MeaningOfLife {

   // we are overriding the default implementation of this method in order
   // to append our pipe
   async fn setup_pipeline_builder(builder: PipelineBuilder<Self>) -> PipelineBuilder<Self> {
      builder.register(|pipeline| {
         Box::pin(async {
              pipeline.store_fn(|mut instance: MeaningOfLife| async {
                   instance.0 = 42;
                   instance
             }).await
         })
       }).await;

       builder
   }
   
}


#[tokio::main]
async fn main() {

   let new_life = MeaningOfLife(0);

   // Register/append a pipe/function to the pipeline
   MeaningOfLife::pipeline_builder().await
     .register(|pipeline| {
          Box::pin(async {
             pipeline.store_fn(|mut instance: MeaningOfLife| async {
                 if instance.0 == 0  {
                     instance.0 = 42 ;
                  } else {
                     instance.0 = instance.0 * 2;
                  }
                  instance
             }).await
         })
      }).await;
 
   let life = new_life.pipeline().await.deliver().await;
   assert_eq!(life.0, 84);
}

Implementations§

Source§

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

Source

pub fn new() -> Self

Source

pub async fn initial() -> (bool, Self)

Source

pub async fn register<F>(&self, callback: F) -> &Self
where F: FnMut(Pipeline<T>) -> BoxFuture<'static, Pipeline<T>> + Send + Sync + 'static,

Source

pub async fn build(&self, content: T) -> Pipeline<T>

Trait Implementations§

Source§

impl<T: Clone + Clone + Send + Sync + 'static> Clone for PipelineBuilder<T>

Source§

fn clone(&self) -> PipelineBuilder<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Clone + Send + Sync + 'static> Default for PipelineBuilder<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for PipelineBuilder<T>

§

impl<T> !RefUnwindSafe for PipelineBuilder<T>

§

impl<T> Send for PipelineBuilder<T>

§

impl<T> Sync for PipelineBuilder<T>

§

impl<T> Unpin for PipelineBuilder<T>

§

impl<T> !UnwindSafe for PipelineBuilder<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V