Struct dyer::plugin::pipeline::PipeLine

pub struct PipeLine<'pl, E, C> {
    pub marker: String,
    pub rank: i16,
    pub extensions: Extensions,
    /* private fields */
}

Represents a medium that manipulates the collected data structure of App

In practise, it processes the collected data and consume it according to the marker and rank

Fields

marker: String

rank: i16

extensions: Extensions

additional arguments for extensive application

Implementations

impl<'pl, E, C> PipeLine<'pl, E, C>

pub fn builder() -> PipeLineBuilder<'pl, E, C>

Create an instance of PipeLinesBuilder that used to build a PipeLine

Examples

async fn process_entity(&mut Vec<E>, &mut App<E>) {}
let pipeline = Pipeline::builder()
    .process_entity(process_entity)
    .build("marker");

pub fn rank(&self) -> i16

get the rank of PipeLine

Examples

async fn process_entity(&mut Vec<E>, &mut App<E>) {}
let pipeline = Pipeline::builder()
    .process_entity(process_entity)
    .build("marker");
assert_eq!(pipeline.rank(), 0);

pub fn rank_mut(&mut self) -> &mut i16

get mutable reference to rank of PipeLine

Examples

async fn process_entity(&mut Vec<E>, &mut App<E>) {}
let pipeline = Pipeline::builder()
    .process_entity(process_entity)
    .build("marker");
pipeline.rank_mut() = 3;
assert_eq!(pipeline.rank(), 3);

pub fn extensions_mut(&mut self) -> &mut Extensions

mutate the extensions of PipeLine

Examples

let mut pipeline = Pipeline::builder()
    .extensions(1i32)
    .build("marker");
pipeline.extension_mut().insert(2i32);

pub fn extensions(&self) -> &Extensions

get extensions of PipeLine

Examples

let pipeline = Pipeline::builder()
    .extensions(1i32)
    .build("marker");
assert_eq!(pipeline.extensions().get::<i32>(), 1);

pub fn initializer_mut(
    self,
    initials: &'pl dyn for<'a> Fn(&'a mut App<E>) -> BoxFuture<'a, Option<C>>
) -> Self

Set the initializer of PipeLine, if not called, the default value is None

Examples

async fn initializer(_: &mut App<E>) {}
let pipeline = PipeLines::builder()
    .initializer_mut(&initializer)
    .build("marker".into());
assert! (pipeline.initializer.is_some())

pub fn initializer(
    &self
) -> Option<&'pl dyn for<'a> Fn(&'a mut App<E>) -> BoxFuture<'a, Option<C>>>

Get the shared reference of initializer of PipeLine, if not set before, None is returned

Examples

async fn initializer(_: &mut App<E>) {}
let pipeline = PipeLines::builder()
    .initializer_mut(&initializer)
    .build("marker".into());
assert_eq! (pipeline.initializer (), Some(initializer))

pub fn disposer_mut(
    self,
    dispose: &'pl dyn for<'a> Fn(&'a mut App<E>) -> BoxFuture<'a, ()>
) -> Self

Set the disposer of PipeLine, if not called, the default value is None

Examples

async fn disposer(_: &mut App<E>) {}
let pipeline = PipeLines::builder()
    .disposer_mut(&disposer)
    .build("marker".into());
assert! (pipeline.disposer.is_some())

pub fn disposer(
    &self
) -> Option<&'pl dyn for<'a> Fn(&'a mut App<E>) -> BoxFuture<'a, ()>>

Get the shared reference of disposer of PipeLine, if not set before, None is returned

Examples

async fn disposer(_: &mut App<E>) {}
let pipeline = PipeLines::builder()
    .disposer_mut(&disposer)
    .build("marker".into());
assert_eq! (pipeline.disposer (), Some(disposer))

pub fn entity_mut(
    self,
    entity: &'pl dyn for<'a> Fn(Vec<E>, &'a mut App<E>) -> BoxFuture<'a, ()>
) -> Self

Set the process_entity of PipeLine, if not called, the default value is None

Examples

async fn process_entity(_ : & mut Vec < E >,_: &mut App<E>) {}
let pipeline = PipeLines::builder()
    .entity_mut(&process_entity)
    .build("marker".into());
assert! (pipeline.process_entity.is_some())

pub fn entity(
    &self
) -> Option<&'pl dyn for<'a> Fn(Vec<E>, &'a mut App<E>) -> BoxFuture<'a, ()>>

Get the shared reference of process_entity of PipeLine, if not set before, None is returned

Examples

async fn process_entity(_ : & mut Vec < E >,_: &mut App<E>) {}
let pipeline = PipeLines::builder()
    .entity_mut(&process_entity)
    .build("marker".into());
assert_eq! (pipeline.entity (), Some(process_entity))

pub fn yerr_mut(
    self,
    yerr: &'pl dyn for<'a> Fn(Vec<Result<Response, MetaResponse>>, &'a mut App<E>) -> BoxFuture<'a, ()>
) -> Self

Set the process_yerr of PipeLine, if not called, the default value is None

Examples

async fn process_yerr(_ : & mut Vec < Result<Response, MetaResponse> >,_: &mut App<E>) {}
let pipeline = PipeLines::builder()
    .yerr_mut(&process_yerr)
    .build("marker".into());
assert! (pipeline.process_yerr.is_some())

pub fn yerr(
    &self
) -> Option<&'pl dyn for<'a> Fn(Vec<Result<Response, MetaResponse>>, &'a mut App<E>) -> BoxFuture<'a, ()>>

Get the shared reference of process_yerr of PipeLine, if not set before, None is returned

Examples

async fn process_yerr(_ : & mut Vec < Result<Response, MetaResponse> >,_: &mut App<E>) {}
let pipeline = PipeLines::builder()
    .yerr_mut(&process_yerr)
    .build("marker".into());
assert_eq! (pipeline.yerr (), Some(process_yerr))