Struct Request 

pub struct Request { /* private fields */ }

An incoming HTTP request from the Cufflink platform.

The platform serializes the full request context (method, headers, body, tenant, service name, auth) into JSON and passes it to your handler.

Implementations

impl Request

pub fn from_json(json: &str) -> Option<Self>

Parse a Request from the JSON the platform provides.

pub fn method(&self) -> &str

The HTTP method (GET, POST, PUT, DELETE).

pub fn handler(&self) -> &str

The handler name from the URL path.

pub fn headers(&self) -> &HashMap<String, String>

All HTTP headers as a map.

pub fn header(&self, name: &str) -> Option<&str>

Get a specific header value.

pub fn body(&self) -> &Value

The parsed JSON body. Returns Value::Null if no body was sent.

pub fn raw_body(&self) -> &[u8]

The raw, unparsed request body bytes as the caller sent them.

Use this when verifying webhook signatures that HMAC over the original payload (Stripe, OpenPhone/Quo, etc.) — the parsed body() is canonicalized by serde_json and will not byte-match what the sender signed. Returns an empty slice when no body was sent.

pub fn tenant(&self) -> &str

The tenant slug from the URL.

pub fn service(&self) -> &str

The service name from the URL.

pub fn auth(&self) -> Option<&Auth>

Get the authenticated user context, if present.

Returns None if no valid JWT or API key was provided with the request.

pub fn job(&self) -> Option<&JobContext>

Get the job context attached by the long-running jobs runtime.

Returns None when the handler is invoked directly via HTTP. Present for handlers annotated with job(...) and dispatched by a worker.

pub fn require_auth(&self) -> Result<&Auth, Response>

Require authentication. Returns the auth context or an error response.

handler!(protected, |req: Request| {
    let auth = match req.require_auth() {
        Ok(auth) => auth,
        Err(resp) => return resp,
    };
    Response::json(&json!({"user": auth.sub}))
});

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.