Struct apalis_core::request::JobRequest

pub struct JobRequest<T> { /* private fields */ }

Represents a job which can be pushed and popped into a Storage.

Its usually passed to a JobService for execution.

Implementations

impl<T> JobRequest<T>

pub fn new(job: T) -> Self

Creates a new JobRequest ready to be pushed to a Storage

pub fn inner(&self) -> &T

Get the underlying reference of the Job

pub fn id(&self) -> String

Get the Uuid for a job

pub fn context_mut(&mut self) -> &mut JobContext

Gets a mutable reference to the job context.

pub fn context(&self) -> &JobContext

Gets a reference to the job context.

pub fn max_attempts(&self) -> i32

Gets the maximum attempts for a job. Default 25

pub fn record_attempt(&mut self)

Records a job attempt

pub fn attempts(&self) -> i32

Gets the current attempts for a job. Default 0

Trait Implementations

impl<T: Clone> Clone for JobRequest<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for JobRequest<T>

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

Formats the value using the given formatter.

impl<T> Deref for JobRequest<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, T> Deserialize<'de> for JobRequest<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'r, T: DeserializeOwned> FromRow<'r, SqliteRow> for JobRequest<T>

fn from_row(row: &'r SqliteRow) -> Result<Self, Error>

impl<T> Policy<JobRequest<T>, JobResult, JobError> for DefaultRetryPolicy where
    T: Clone, 

type Future = Ready<DefaultRetryPolicy>

The Future type returned by Policy::retry.

fn retry(
    &self,
    req: &JobRequest<T>,
    result: Result<&JobResult, &JobError>
) -> Option<Self::Future>

Check the policy if a certain request should be retried.

fn clone_request(&self, req: &JobRequest<T>) -> Option<JobRequest<T>>

Tries to clone a request before being passed to the inner service.

impl<T> Serialize for JobRequest<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<J, S, T> Service<JobRequest<J>> for AddExtension<S, T> where
    S: Service<JobRequest<J>>,
    T: Clone + Send + Sync + 'static, 

type Response = <S as Service<JobRequest<J>>>::Response

Responses given by the service.

type Error = <S as Service<JobRequest<J>>>::Error

Errors produced by the service.

type Future = <S as Service<JobRequest<J>>>::Future

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: JobRequest<J>) -> Self::Future

Process the request and return the response asynchronously.

impl<Request> Service<JobRequest<Request>> for JobService where
    Request: Debug + Job + 'static, 

type Response = JobResult

Responses given by the service.

type Error = JobError

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<JobService as Service<JobRequest<Request>>>::Response, <JobService as Service<JobRequest<Request>>>::Error>> + 'static, Global>>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, job: JobRequest<Request>) -> Self::Future

Process the request and return the response asynchronously.