When a Runnable is used to handle an HTTP request, Atmo will bind that request to the Runnable. The req namespace of the Runnable API can then be used to access all of the information about the request. Note if the Runnable is not being used to handle a request, then all methods in the req namespace will return empty or an error.

For Rust, these methods are available under the req module, for example req::method(). For Swift, they are prefixed with Req, for example Suborbital.ReqMethod(). For TypeScript/AssemblyScript, they are prefixed with req, for example import { reqState } from '@suborbital/suborbital'

The following namespace methods are available:

State

Returns the value from request state for the provided key:

Rust:

pub fn state(key: &str) -> Option<String>

AssemblyScript:

function reqState(key: string): string

Swift:

public func State(key: String) -> String

Method

Returns the HTTP method for the request:

Rust:

pub fn method() -> String

AssemblyScript:

function reqMethod(): string

Swift:

public func ReqMethod() -> String

URL

Returns the full URL of the request:

Rust:

pub fn url() -> String

AssemblyScript:

function reqURL(): string

Swift:

public func ReqURL() -> String

ID

Returns the unique ID assigned to the request by Atmo:

Rust:

pub fn id() -> String

AssemblyScript:

function reqID(): string

Swift:

public func ReqID() -> String

Body

Returns the full request body as bytes:

Rust:

pub fn body_raw() -> Vec<u8>

AssemblyScript:

function reqBody(): ArrayBuffer

Swift:

public func ReqBodyRaw() -> String

Body Field

Returns the value for the provided key, if the request body is formatted as JSON:

Rust:

pub fn body_field(key: &str) -> String

AssemblyScript:

function reqBodyField(key: string): string

Swift:

public func ReqBodyField(key: String) -> String

Header

Returns the header value for the provided key:

Rust:

pub fn header(key: &str) -> String

AssemblyScript:

function reqHeader(key: string): string

Swift:

public func ReqHeader(key: String) -> String

URL Parameter

Returns the URL parameter for the provided key, for example /api/v1/user/:uuid

Rust:

pub fn url_param(key: &str) -> String

AssemblyScript:

function reqURLParam(key: string): string

Swift:

public func ReqParam(key: String) -> String