Struct Signature 

pub struct Signature {
    pub task_name: String,
    pub queue: String,
    pub payload: Value,
    pub max_retries: u32,
    pub eta: Option<DateTime<Utc>>,
    pub headers: HashMap<String, String>,
}

A type-erased task invocation descriptor.

Signatures describe what to run without running it immediately. They can be composed into workflows via Canvas.

Fields

task_name: String

Registered task name.

queue: String

Target queue.

payload: Value

Serialized task payload.

max_retries: u32

Maximum retries.

eta: Option<DateTime<Utc>>

Optional ETA.

headers: HashMap<String, String>

Arbitrary headers.

Implementations

impl Signature

pub fn new( task_name: impl Into<String>, queue: impl Into<String>, payload: Value, ) -> Signature

Create a new signature.

pub fn with_max_retries(self, max_retries: u32) -> Signature

Set max retries.

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

Set ETA.

pub fn with_header( self, key: impl Into<String>, value: impl Into<String>, ) -> Signature

Add a header.

pub fn into_message(self) -> TaskMessage

Convert this signature into a TaskMessage ready for enqueuing.

Trait Implementations

impl BitOr for Signature

type Output = Canvas

The resulting type after applying the | operator.

fn bitor(self, rhs: Signature) -> <Signature as BitOr>::Output

Performs the | operation.

impl Clone for Signature

fn clone(&self) -> Signature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Signature

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Signature> for Canvas

fn from(sig: Signature) -> Canvas

Converts to this type from the input type.

impl Serialize for Signature

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

where __S: Serializer,

Serialize this value into the given Serde serializer.