Skip to main content

JobQueue

Struct JobQueue 

Source
pub struct JobQueue(pub Arc<dyn StorageBackend>);
Expand description

Actix Web request extractor for enqueueing background jobs from HTTP handlers.

§Examples

use actix_web::{post, web, App, HttpResponse, HttpServer, Responder};
use azums_actix::{BackgroundJobs, JobQueue};
use serde_json::json;

#[post("/orders")]
async fn create_order(queue: JobQueue) -> impl Responder {
    let job_id = queue
        .enqueue_now("default", "process_order", json!({"item": "book"}))
        .await
        .unwrap();
    HttpResponse::Ok().json(json!({ "status": "queued", "id": job_id }))
}

Tuple Fields§

§0: Arc<dyn StorageBackend>

Implementations§

Source§

impl JobQueue

Source

pub fn new(backend: Arc<dyn StorageBackend>) -> Self

Creates a JobQueue wrapping a StorageBackend.

Source

pub fn backend(&self) -> &Arc<dyn StorageBackend> ⓘ

Returns reference to the underlying StorageBackend.

Source

pub async fn enqueue(&self, job: impl Into<NewJob>) -> Result<Uuid>

Enqueues a NewJob or Job into the queue.

Source

pub async fn enqueue_now( &self, queue: &str, job_type: &str, payload_json: Value, ) -> Result<Uuid>

Enqueues a job immediately with default queue "default", priority 0, and 25 max attempts.

Source

pub async fn enqueue_in( &self, queue: &str, job_type: &str, payload_json: Value, delay_secs: i64, ) -> Result<Uuid>

Enqueues a job delayed by delay_secs seconds.

Source

pub async fn enqueue_at( &self, queue: &str, job_type: &str, payload_json: Value, run_at: DateTime<Utc>, ) -> Result<Uuid>

Enqueues a job scheduled for a specific UTC timestamp (run_at).

Trait Implementations§

Source§

impl Clone for JobQueue

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl FromRequest for JobQueue

Source§

type Error = Error

The associated error which can be returned.
Source§

type Future = Ready<Result<JobQueue, <JobQueue as FromRequest>::Error>>

Future that resolves to a Self. Read more
Source§

fn from_request(req: &HttpRequest, _payload: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.
Source§

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously. Read more

Auto Trait Implementations§

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> 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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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

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