Struct apalis_core::storage::StorageWorker

source · [−]

pub struct StorageWorker<T: Serialize, S: Storage<Output = T>, H> { /* private fields */ }

Available on crate feature storage only.

Expand description

A queue represents a consumer of a Storage.

A [Service] must be provided to be called when a new job is detected.

Implementations

source

impl<T, S, H> StorageWorker<T, S, H> where
T: 'static + Job + Serialize + Debug + DeserializeOwned,
S: 'static + Storage<Output = T> + Unpin,

source

pub fn new(storage: S, handler: H) -> Self

Create a new Worker instance

source

pub fn config(self, config: StorageWorkerConfig) -> StorageWorker<T, S, H>

Set a [WorkerConfig] for Worker

Trait Implementations

source

impl<T: Debug + Serialize, S: Debug + Storage<Output = T>, H: Debug> Debug for StorageWorker<T, S, H>

source

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

Formats the value using the given formatter. Read more

source

impl<T: 'static, S: 'static, H: 'static, F> Handler<StorageWorkerPulse> for StorageWorker<T, S, H> where
 S: Storage<Output = T> + Unpin + Send + Sync,
 T: Job + Serialize + Debug + DeserializeOwned + Send,
 H: Service<JobRequest<T>, Response = JobResult, Error = JobError, Future = F> + Unpin + Send + 'static,
 F: Future<Output = Result<JobResult, JobError>> + Send,

type Result = ()

Available on crate feature worker only.

Result of handler

source

fn handle<'life0, 'async_trait>(
 &'life0 mut self,
 beat: StorageWorkerPulse
) -> Pin<Box<dyn Future<Output = Self::Result> + Send + 'async_trait>> where
 'life0: 'async_trait,
 Self: 'async_trait,

Available on crate feature worker only.

Message handler

source

impl<T, S, H, F> Worker for StorageWorker<T, S, H> where
 S: JobStream<Job = T> + Storage + Unpin + Storage<Output = T> + Send + 'static + Sync,
 T: Job + Send + 'static,
 H: Service<JobRequest<T>, Response = JobResult, Error = JobError, Future = F> + Unpin + Send + 'static,
 F: Future<Output = Result<JobResult, JobError>> + Send,

type Job = T

Available on crate feature worker only.

The job type for the worker

type Service = H

Available on crate feature worker only.

The tower service to process job requests

type Future = F

Available on crate feature worker only.

The future returened by our tower service

source

fn on_start<'life0, 'life1, 'async_trait>(
 &'life0 mut self,
 ctx: &'life1 mut Context<Self>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Available on crate feature worker only.

At start hook of worker

source

fn on_stop<'life0, 'life1, 'async_trait>(
 &'life0 mut self,
 _ctx: &'life1 mut Context<Self>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Available on crate feature worker only.

At stop hook of worker

source

fn consume(&mut self) -> JobStreamResult<Self::Job>

Available on crate feature worker only.

Returns a streams of jobs for the worker to consume

source

fn service(&mut self) -> &mut Self::Service

Available on crate feature worker only.

Returns the service that handles the job

source

fn handle_job<'life0, 'async_trait>(
 &'life0 mut self,
 job: JobRequest<Self::Job>
) -> Pin<Box<dyn Future<Output = Result<JobResult, JobError>> + Send + 'async_trait>> where
 'life0: 'async_trait,
 Self: 'async_trait,

Available on crate feature worker only.

The way the worker will handle a job

source

fn manage<'life0, 'async_trait>(
 &'life0 mut self,
 _msg: WorkerManagement
) -> Pin<Box<dyn Future<Output = Result<WorkerStatus, WorkerError>> + Send + 'async_trait>> where
 'life0: 'async_trait,
 Self: 'async_trait,

Available on crate feature worker only.

Manage a worker

Auto Trait Implementations

impl<T, S, H> RefUnwindSafe for StorageWorker<T, S, H> where
H: RefUnwindSafe,
S: RefUnwindSafe,

impl<T, S, H> Send for StorageWorker<T, S, H> where
H: Send,
S: Send,

impl<T, S, H> Sync for StorageWorker<T, S, H> where
H: Sync,
S: Sync,

impl<T, S, H> Unpin for StorageWorker<T, S, H> where
H: Unpin,
S: Unpin,

impl<T, S, H> UnwindSafe for StorageWorker<T, S, H> where
H: UnwindSafe,
S: UnwindSafe,

Blanket Implementations

source

impl<T, W> Actor for W where
T: 'static + Send,
W: 'static + Worker<Job = T> + Handler<JobRequestWrapper<T>>,

source

fn on_start<'life0, 'life1, 'async_trait>(
 &'life0 mut self,
 ctx: &'life1 mut Context<W>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 W: 'async_trait,

Available on crate feature worker only.

At start hook of actor

source

fn on_stop<'life0, 'life1, 'async_trait>(
 &'life0 mut self,
 ctx: &'life1 mut Context<W>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 W: 'async_trait,

Available on crate feature worker only.

At stop hook of actor

source

fn mailbox_capacity(&self) -> usize

Available on crate feature worker only.

Capacity of worker queue

source

fn preinit(self) -> InitializedActor<Self>

Available on crate feature worker only.

Initilize actor with its address.

source

fn preinit_default() -> InitializedActor<Self> where
Self: Default,

Available on crate feature worker only.

Initialize actor with default values

source

fn start<'async_trait>(
self
) -> Pin<Box<dyn Future<Output = Addr<Self>> + Send + 'async_trait>> where
Self: 'async_trait,

Available on crate feature worker only.

Starts an actor and returns its address

source

fn start_default<'async_trait>(
) -> Pin<Box<dyn Future<Output = Addr<Self>> + Send + 'async_trait>> where
Self: Default,
Self: 'async_trait,

Available on crate feature worker only.

Starts an actor with default values and returns its address

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<M, S> ContextHandler<M> for S where
M: 'static + Message + Send,
S: Handler<M>,

type Result = <S as Handler<M>>::Result

Available on crate feature worker only.

Result of handler

source

fn handle<'life0, 'life1, 'async_trait>(
 &'life0 mut self,
 __arg1: &'life1 mut Context<S>,
 msg: M
) -> Pin<Box<dyn Future<Output = <S as ContextHandler<M>>::Result> + Send + 'async_trait, Global>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 S: 'async_trait,

Available on crate feature worker only.

Message handler

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, W> Handler<JobRequestWrapper<T>> for W where
W: 'static + Worker<Job = T>,
T: 'static + Job + Serialize + Debug + DeserializeOwned + Send,

type Result = ()

Available on crate feature worker only.

Result of handler

source

fn handle<'life0, 'async_trait>(
 &'life0 mut self,
 job: JobRequestWrapper<T>
) -> Pin<Box<dyn Future<Output = <W as Handler<JobRequestWrapper<T>>>::Result> + Send + 'async_trait, Global>> where
 'life0: 'async_trait,
 W: 'async_trait,

Available on crate feature worker only.

Message handler

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct apalis_core::storage::StorageWorker

Implementations

impl<T, S, H> StorageWorker<T, S, H> where T: 'static + Job + Serialize + Debug + DeserializeOwned, S: 'static + Storage<Output = T> + Unpin,

pub fn new(storage: S, handler: H) -> Self

pub fn config(self, config: StorageWorkerConfig) -> StorageWorker<T, S, H>

Trait Implementations

impl<T: Debug + Serialize, S: Debug + Storage<Output = T>, H: Debug> Debug for StorageWorker<T, S, H>

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

type Result = ()

fn handle<'life0, 'async_trait>( &'life0 mut self, beat: StorageWorkerPulse) -> Pin<Box<dyn Future<Output = Self::Result> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,

type Job = T

type Service = H

type Future = F

fn on_start<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 mut Context<Self>) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn on_stop<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut Context<Self>) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn consume(&mut self) -> JobStreamResult<Self::Job>

fn service(&mut self) -> &mut Self::Service

fn handle_job<'life0, 'async_trait>( &'life0 mut self, job: JobRequest<Self::Job>) -> Pin<Box<dyn Future<Output = Result<JobResult, JobError>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,

fn manage<'life0, 'async_trait>( &'life0 mut self, _msg: WorkerManagement) -> Pin<Box<dyn Future<Output = Result<WorkerStatus, WorkerError>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,

Auto Trait Implementations

impl<T, S, H> RefUnwindSafe for StorageWorker<T, S, H> where H: RefUnwindSafe, S: RefUnwindSafe,

impl<T, S, H> Send for StorageWorker<T, S, H> where H: Send, S: Send,

impl<T, S, H> Sync for StorageWorker<T, S, H> where H: Sync, S: Sync,

impl<T, S, H> Unpin for StorageWorker<T, S, H> where H: Unpin, S: Unpin,

impl<T, S, H> UnwindSafe for StorageWorker<T, S, H> where H: UnwindSafe, S: UnwindSafe,

Blanket Implementations

impl<T, W> Actor for W where T: 'static + Send, W: 'static + Worker<Job = T> + Handler<JobRequestWrapper<T>>,

fn on_start<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 mut Context<W>) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where 'life0: 'async_trait, 'life1: 'async_trait, W: 'async_trait,

fn on_stop<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 mut Context<W>) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where 'life0: 'async_trait, 'life1: 'async_trait, W: 'async_trait,

fn mailbox_capacity(&self) -> usize

fn preinit(self) -> InitializedActor<Self>

fn preinit_default() -> InitializedActor<Self> where Self: Default,

fn start<'async_trait>( self) -> Pin<Box<dyn Future<Output = Addr<Self>> + Send + 'async_trait>> where Self: 'async_trait,

fn start_default<'async_trait>() -> Pin<Box<dyn Future<Output = Addr<Self>> + Send + 'async_trait>> where Self: Default, Self: 'async_trait,

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<M, S> ContextHandler<M> for S where M: 'static + Message + Send, S: Handler<M>,

type Result = <S as Handler<M>>::Result

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, __arg1: &'life1 mut Context<S>, msg: M) -> Pin<Box<dyn Future<Output = <S as ContextHandler<M>>::Result> + Send + 'async_trait, Global>> where 'life0: 'async_trait, 'life1: 'async_trait, S: 'async_trait,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, W> Handler<JobRequestWrapper<T>> for W where W: 'static + Worker<Job = T>, T: 'static + Job + Serialize + Debug + DeserializeOwned + Send,

type Result = ()

fn handle<'life0, 'async_trait>( &'life0 mut self, job: JobRequestWrapper<T>) -> Pin<Box<dyn Future<Output = <W as Handler<JobRequestWrapper<T>>>::Result> + Send + 'async_trait, Global>> where 'life0: 'async_trait, W: 'async_trait,

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T, S, H> StorageWorker<T, S, H> where
T: 'static + Job + Serialize + Debug + DeserializeOwned,
S: 'static + Storage<Output = T> + Unpin,

fn handle<'life0, 'async_trait>(
&'life0 mut self,
beat: StorageWorkerPulse
) -> Pin<Box<dyn Future<Output = Self::Result> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,

fn on_start<'life0, 'life1, 'async_trait>(
&'life0 mut self,
ctx: &'life1 mut Context<Self>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn on_stop<'life0, 'life1, 'async_trait>(
&'life0 mut self,
_ctx: &'life1 mut Context<Self>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn handle_job<'life0, 'async_trait>(
&'life0 mut self,
job: JobRequest<Self::Job>
) -> Pin<Box<dyn Future<Output = Result<JobResult, JobError>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,

fn manage<'life0, 'async_trait>(
&'life0 mut self,
_msg: WorkerManagement
) -> Pin<Box<dyn Future<Output = Result<WorkerStatus, WorkerError>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,

impl<T, S, H> RefUnwindSafe for StorageWorker<T, S, H> where
H: RefUnwindSafe,
S: RefUnwindSafe,

impl<T, S, H> Send for StorageWorker<T, S, H> where
H: Send,
S: Send,

impl<T, S, H> Sync for StorageWorker<T, S, H> where
H: Sync,
S: Sync,

impl<T, S, H> Unpin for StorageWorker<T, S, H> where
H: Unpin,
S: Unpin,

impl<T, S, H> UnwindSafe for StorageWorker<T, S, H> where
H: UnwindSafe,
S: UnwindSafe,

impl<T, W> Actor for W where
T: 'static + Send,
W: 'static + Worker<Job = T> + Handler<JobRequestWrapper<T>>,

fn on_start<'life0, 'life1, 'async_trait>(
&'life0 mut self,
ctx: &'life1 mut Context<W>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
'life1: 'async_trait,
W: 'async_trait,

fn on_stop<'life0, 'life1, 'async_trait>(
&'life0 mut self,
ctx: &'life1 mut Context<W>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
'life1: 'async_trait,
W: 'async_trait,

fn preinit_default() -> InitializedActor<Self> where
Self: Default,

fn start<'async_trait>(
self
) -> Pin<Box<dyn Future<Output = Addr<Self>> + Send + 'async_trait>> where
Self: 'async_trait,

fn start_default<'async_trait>(
) -> Pin<Box<dyn Future<Output = Addr<Self>> + Send + 'async_trait>> where
Self: Default,
Self: 'async_trait,

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

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

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

impl<M, S> ContextHandler<M> for S where
M: 'static + Message + Send,
S: Handler<M>,

fn handle<'life0, 'life1, 'async_trait>(
&'life0 mut self,
__arg1: &'life1 mut Context<S>,
msg: M
) -> Pin<Box<dyn Future<Output = <S as ContextHandler<M>>::Result> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
'life1: 'async_trait,
S: 'async_trait,

impl<T, W> Handler<JobRequestWrapper<T>> for W where
W: 'static + Worker<Job = T>,
T: 'static + Job + Serialize + Debug + DeserializeOwned + Send,

fn handle<'life0, 'async_trait>(
&'life0 mut self,
job: JobRequestWrapper<T>
) -> Pin<Box<dyn Future<Output = <W as Handler<JobRequestWrapper<T>>>::Result> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
W: 'async_trait,

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,