Struct Payload 

pub struct Payload<T>(pub T);

A typed wrapper around a deserialized job payload.

Use Payload<T> as a parameter in job handler functions to receive the deserialized payload. T must implement serde::de::DeserializeOwned.

Payload<T> implements Deref<Target = T>, so methods on T are accessible directly without .0.

Example

use modo::job::Payload;
use serde::Deserialize;

#[derive(Deserialize)]
struct WelcomePayload { user_id: String }

async fn handle(payload: Payload<WelcomePayload>) -> modo::Result<()> {
    println!("user_id = {}", payload.user_id);
    Ok(())
}

Tuple Fields

0: T

Trait Implementations

impl<T> Deref for Payload<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: DeserializeOwned> FromJobContext for Payload<T>

fn from_job_context(ctx: &JobContext) -> Result<Self>

Extract Self from the job context, returning an error if extraction fails.