Struct faktory::Job

pub struct Job {
    pub queue: String,
    pub created_at: Option<DateTime<Utc>>,
    pub enqueued_at: Option<DateTime<Utc>>,
    pub at: Option<DateTime<Utc>>,
    pub reserve_for: Option<usize>,
    pub retry: Option<isize>,
    pub priority: Option<u8>,
    pub backtrace: Option<usize>,
    pub custom: HashMap<String, Value>,
    /* private fields */
}

A Faktory job.

To create a job, use ‘Job::new’ specifying ‘kind’ and ‘args’:

use faktory::Job;

let _job = Job::new("order", vec!["ISBN-13:9781718501850"]);

Alternatively, use JobBuilder to configure more aspects of a job:

use faktory::JobBuilder;

let _job = JobBuilder::new("order")
    .args(vec!["ISBN-13:9781718501850"])
    .build();

Equivalently:

use faktory::Job;

let _job = Job::builder("order")
    .args(vec!["ISBN-13:9781718501850"])
    .build();

In case no arguments are expected ‘on the other side’, you can simply go with:

use faktory::Job;

let _job = Job::builder("rebuild_index").build();

See also the Faktory wiki.

Fields

queue: String

The queue this job belongs to. Usually default.

created_at: Option<DateTime<Utc>>

When this job was created.

enqueued_at: Option<DateTime<Utc>>

When this job was supplied to the Faktory server.

at: Option<DateTime<Utc>>

When this job is scheduled for.

Defaults to immediately.

reserve_for: Option<usize>

How long to allow this job to run for.

Defaults to 600 seconds.

retry: Option<isize>

Number of times to retry this job.

Defaults to 25.

priority: Option<u8>

The priority of this job from 1-9 (9 is highest).

Pushing a job with priority 9 will effectively put it at the front of the queue. Defaults to 5.

backtrace: Option<usize>

Number of lines of backtrace to keep if this job fails.

Defaults to 0.

custom: HashMap<String, Value>

Extra context to include with the job.

Faktory workers can have plugins and middleware which need to store additional context with the job payload. Faktory supports a custom hash to store arbitrary key/values in the JSON. This can be extremely helpful for cross-cutting concerns which should propagate between systems, e.g. locale for user-specific text translations, request_id for tracing execution across a complex distributed system, etc.

Implementations

impl Job

pub fn new<S, A>(kind: S, args: Vec<A>) -> Self

where S: Into<String>, A: Into<Value>,

Create a new job of type kind, with the given arguments.

pub fn builder<S: Into<String>>(kind: S) -> JobBuilder

Creates an ergonomic constructor for a new Job.

Also equivalent to JobBuilder::new.

pub fn on_queue<S: Into<String>>(self, queue: S) -> Self

Place this job on the given queue.

If this method is not called (or self.queue set otherwise), the queue will be set to “default”.

pub fn id(&self) -> &str

This job’s id.

pub fn kind(&self) -> &str

This job’s type.

pub fn args(&self) -> &[Value]

The arguments provided for this job.

pub fn failure(&self) -> &Option<Failure>

Data about this job’s most recent failure.

Trait Implementations

impl Clone for Job

fn clone(&self) -> Job

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Job

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Job

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Job

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

where __S: Serializer,

Serialize this value into the given Serde serializer.