Struct ocypod::application::RedisJob

pub struct RedisJob<'a> {
    pub id: u64,
    pub key: String,
    /* private fields */
}

Convenient wrapper struct for combing a job ID plus a connection.

Fields

id: u64

key: String

Implementations

impl<'a> RedisJob<'a>

pub fn new(id: u64, conn: &'a Connection) -> Self

Create a new RedisJob with given ID and given connection. This ID may or may not exist.

pub fn metadata(&self, fields: &[Field]) -> OcyResult<JobMeta>

Get a populated JobMeta from given connection by getting data for a given hash key and fields.

pub fn timeout_metadata(&self) -> OcyResult<TimeoutMeta>

Get subset of metadata needed to check whether this job has timed out or not.

pub fn id(&self) -> u64

Get this job’s ID.

pub fn key(&self) -> &str

Get this job’s Redis key.

pub fn build_key(id: u64) -> String

Create a Redis key for a job from a job ID.

pub fn update(&self, update_req: &UpdateRequest) -> OcyResult<()>

Update this job’s status and/or output from a given request.

pub fn complete<'b>(&self, pipe: &'b mut Pipeline) -> &'b mut Pipeline

Add commands to a pipeline to mark this job as completed.

Note: caller is responsible for ensuring job exists and status change is valid before this is called.

pub fn requeue<'b>(
    &self,
    pipe: &'b mut Pipeline,
    incr_retries: bool
) -> OcyResult<&'b mut Pipeline>

Add commands to pipeline to re-queue this job so that it can be retried later.

If incr_retries is true, then increment the count of retry attempts for this job. This will typically be done for automatic retries, but not for manually requested retries.

pub fn cancel<'b>(&self, pipe: &'b mut Pipeline) -> OcyResult<&'b mut Pipeline>

Add commands to pipeline to re-queue this job so that it can be retried later.

pub fn fail<'b>(
    &self,
    pipe: &'b mut Pipeline,
    status: &Status
) -> &'b mut Pipeline

Add commands to pipeline to mark this job as failed or timed out.

Note: caller is responsible for ensuring job exists and status change is valid before this is called.

pub fn end_failed(&self) -> OcyResult<bool>

Move this job to the ended queue if it’s failed or timed out.

pub fn fields(&self, fields: Option<&[Field]>) -> OcyResult<JobMeta>

Get some or all fields of this job’s metadata.

If None is given, then all fields are fetched.

pub fn queue(&self) -> OcyResult<RedisQueue<'_>>

Get queue this job was created in. This queue may or may not exist.

pub fn output(&self) -> OcyResult<Value>

Get this job’s output field.

pub fn set_output(&self, value: &Value) -> OcyResult<()>

Update this job’s output field in a transaction.

pub fn set_output_in_pipe<'b>(
    &self,
    pipe: &'b mut Pipeline,
    value: &Value
) -> OcyResult<&'b mut Pipeline>

Add commands to update this job’s output to a pipeline.

pub fn status(&self) -> OcyResult<Status>

Get this job’s status field.

pub fn set_status(&self, status: &Status) -> OcyResult<()>

Update this job’s status field in a transaction.

pub fn set_status_in_pipe<'b>(
    &self,
    pipe: &'b mut Pipeline,
    status: &Status
) -> OcyResult<&'b mut Pipeline>

Add commands to update this job’s status to a pipeline.

Checks the validity of status transitions.

pub fn update_heartbeat(&self) -> OcyResult<()>

Updates a job’s last heartbeat date/time.

pub fn apply_expiry(&self) -> OcyResult<bool>

Expires a job in a transaction.

Callers should typically check for job expiry outside of a transaction (and probably in a pipeline), then only call this on jobs to expire (since transaction here is much more expensive).

pub fn apply_timeouts(&self) -> OcyResult<bool>

Times out a job in a transaction.

Callers should typically check for job timeout outside of a transaction (and probably in a pipeline), then only call this on jobs to timeout (since transaction here is much more expensive).

pub fn apply_retries(&self) -> OcyResult<bool>

Retries out a job in a transaction.

Callers should typically check for job retries outside of a transaction (and probably in a pipeline), then only call this on jobs to retry (since transaction here is much more expensive).

pub fn delete(&self) -> OcyResult<bool>

Deletes this job from the server in a transaction.

Returns

Returns true if this job was deleted, false if the job wasn’t found.

pub fn delete_in_pipe<'b>(
    &self,
    pipe: &'b mut Pipeline
) -> OcyResult<&'b mut Pipeline>

Add commands to delete this job status to a pipeline.

Trait Implementations

impl<'a> ToRedisArgs for &'a RedisJob<'a>

fn to_redis_args(&self) -> Vec<Vec<u8>>

This converts the value into a vector of bytes. Each item is a single argument. Most items generate a vector of a single item.

fn write_redis_args(&self, out: &mut Vec<Vec<u8>>)

This writes the value into a vector of bytes. Each item is a single argument. Most items generate a single item.

fn describe_numeric_behavior(&self) -> NumericBehavior

Returns an information about the contained value with regards to it’s numeric behavior in a redis context. This is used in some high level concepts to switch between different implementations of redis functions (for instance INCR vs INCRBYFLOAT).

fn is_single_arg(&self) -> bool

Returns an indiciation if the value contained is exactly one argument. It returns false if it’s zero or more than one. This is used in some high level functions to intelligently switch between GET and MGET variants.