Struct Signature

pub struct Signature<T>
where
    T: Task,
{ /* private fields */ }

Wraps the parameters and execution options for a single task invocation.

When you define a task through the task attribute macro, calling T::new(...) with the arguments that your task function take will create a Signature<T>.

Examples

use celery::prelude::*;

#[celery::task]
fn add(x: i32, y: i32) -> TaskResult<i32> {
    Ok(x + y)
}

let signature = add::new(1, 2);

Implementations

impl<T> Signature<T>

where T: Task,

pub fn new(params: T::Params) -> Self

Create a new Signature from task parameters.

pub fn task_name() -> &'static str

Get the name of the task.

pub fn with_queue(self, queue: &str) -> Self

Set the queue.

pub fn with_countdown(self, countdown: u32) -> Self

Set the countdown.

pub fn with_eta(self, eta: DateTime<Utc>) -> Self

Set the ETA.

pub fn with_expires_in(self, expires_in: u32) -> Self

Set the number of seconds until the task expires.

pub fn with_expires(self, expires: DateTime<Utc>) -> Self

Set the expiration time.

pub fn with_content_type(self, content_type: MessageContentType) -> Self

Set the content type serialization format for the message body.

pub fn with_time_limit(self, time_limit: u32) -> Self

Set a time limit (in seconds) for the task.

pub fn with_hard_time_limit(self, time_limit: u32) -> Self

Set a hard time limit (in seconds) for the task.

Note that this is really only for compatability with Python workers. time_limit and hard_time_limit are treated the same by Rust workers, and if both are set, the minimum of the two will be used.

Trait Implementations

impl<T> Clone for Signature<T>

where T: Task + Clone, T::Params: Clone,

fn clone(&self) -> Signature<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> TryCreateMessage for Signature<T>

where T: Task + Clone,

fn try_create_message(&self) -> Result<Message, ProtocolError>

Creating a message from a signature without consuming the signature requires cloning it. For one-shot conversions, directly use Message::try_from instead.

impl<T> TryFrom<Signature<T>> for Message

where T: Task,

fn try_from(task_sig: Signature<T>) -> Result<Self, Self::Error>

Get a new MessageBuilder from a task signature.

type Error = ProtocolError

The type returned in the event of a conversion error.