Struct apalis_core::builder::WorkerBuilder

pub struct WorkerBuilder<Job, Source, Middleware> { /* private fields */ }

An abstract that allows building a Worker. Usually the output is ReadyWorker but you can implement your own via WorkerFactory

Implementations

impl WorkerBuilder<(), (), Identity>

pub fn new<T: AsRef<str>>(name: T) -> WorkerBuilder<(), (), Identity>

Build a new WorkerBuilder instance with a name for the worker to build

impl<J, S, M> WorkerBuilder<J, S, M>

pub fn stream<NS: Stream<Item = Result<Option<JobRequest<NJ>>, E>>, E, NJ>( self, stream: NS ) -> WorkerBuilder<NJ, NS, M>

Consume a stream directly

pub fn with_stream<NS: Fn(&WorkerId) -> ST, NJ, E, ST: Stream<Item = Result<Option<JobRequest<NJ>>, E>>>( self, stream: NS ) -> WorkerBuilder<NJ, ST, M>

Get the WorkerId and build a stream. Useful when you want to know what worker is consuming the stream.

impl<Job, Stream, Serv> WorkerBuilder<Job, Stream, Serv>

pub fn middleware<NewService>( self, f: impl Fn(ServiceBuilder<Serv>) -> ServiceBuilder<NewService> ) -> WorkerBuilder<Job, Stream, NewService>

Allows of decorating the service that consumes jobs. Allows adding multiple tower middleware

pub fn layer<U>(self, layer: U) -> WorkerBuilder<Job, Stream, Stack<U, Serv>>where Serv: Layer<U>,

Shorthand for decoration. Allows adding a single layer tower middleware

Trait Implementations

impl<Job, Source, Middleware> Debug for WorkerBuilder<Job, Source, Middleware>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<J: 'static, M, Mq> WithMq<Stack<Extension<Mq>, Stack<AckLayer<Mq, J>, M>>, Mq> for WorkerBuilder<(), (), M>where Mq: MessageQueue<J> + Send + Sync + 'static + Clone + Ack<J>, M: Send + Sync + 'static,

Available on crate feature mq only.

type Job = J

The job to consume

type Stream = Pin<Box<dyn Stream<Item = Result<Option<JobRequest<J>>, JobStreamError>> + Send>>

The MessageQueue to produce jobs

fn with_mq( self, mq: Mq ) -> WorkerBuilder<J, Self::Stream, Stack<Extension<Mq>, Stack<AckLayer<Mq, J>, M>>>

The builder method to produce a default WorkerBuilder that will consume jobs

impl<J: 'static + Send + Sync, M, ST> WithStorage<Stack<Extension<ST>, Stack<AckLayer<ST, J>, M>>, ST> for WorkerBuilder<(), (), M>where ST: Storage<Output = J> + Send + Sync + 'static, M: Send + Sync + 'static,

Available on crate feature storage only.

type Job = J

The job to consume

type Stream = Pin<Box<dyn Stream<Item = Result<Option<JobRequest<J>>, JobStreamError>> + Send>>

The source of jobs

fn with_storage_config( self, storage: ST, config: impl Fn(WorkerConfig) -> WorkerConfig ) -> WorkerBuilder<J, Self::Stream, Stack<Extension<ST>, Stack<AckLayer<ST, J>, M>>>

The builder method to produce a configured WorkerBuilder that will consume jobs

fn with_storage(self, storage: ST) -> WorkerBuilder<Self::Job, Self::Stream, NS>

The builder method to produce a default WorkerBuilder that will consume jobs

impl<J, S, M, Ser, E, Request> WorkerFactory<J, Ser> for WorkerBuilder<J, S, M>where S: Stream<Item = Result<Option<Request>, E>> + Send + 'static + Unpin, J: Job + Send + 'static, M: Layer<Ser>, <M as Layer<Ser>>::Service: Service<Request> + Send + 'static, E: Sync + Send + 'static + Error, Request: Send + HasJobContext, <<M as Layer<Ser>>::Service as Service<Request>>::Future: Send + 'static, Ser: Service<Request>, <Ser as Service<Request>>::Error: Debug, <<M as Layer<Ser>>::Service as Service<Request>>::Error: Debug,

fn build(self, service: Ser) -> ReadyWorker<S, <M as Layer<Ser>>::Service>

Convert a worker builder to a worker ready to consume jobs

type Worker = ReadyWorker<S, <M as Layer<Ser>>::Service>

The worker to build