Struct ApiContext 

pub struct ApiContext { /* private fields */ }

Request context passed to API route handlers.

Implementations

impl ApiContext

pub fn connection_id(&self) -> &str

Returns the logical connection id for the current client.

pub fn peer_addr(&self) -> Option<SocketAddr>

Returns the peer socket address when available.

pub fn peer_ip(&self) -> Option<String>

Returns the peer IP as a string when available.

pub fn request_id(&self) -> &str

Returns the request correlation id.

pub fn route(&self) -> &str

Returns the matched route name.

pub fn params(&self) -> &Value

Returns the raw JSON params payload.

pub fn param(&self, key: &str) -> Option<&Value>

Looks up a single parameter by key.

pub fn require_param(&self, key: &str) -> Result<&Value, ApiError>

Looks up a required parameter or returns a bad request error.

pub fn bind<T>(&self) -> Result<T, ApiError>

where T: DeserializeOwned,

Binds the raw params payload into a strongly typed value.

pub fn bind_and_validate<T>(&self) -> Result<T, ApiError>

where T: DeserializeOwned + ValidateParams,

Binds params and runs ValidateParams on the result.

pub fn bind_validated<T>(&self) -> Result<T, ApiError>

where T: DeserializeOwned + Validate,

Binds params and runs validator::Validate on the result.

pub fn attachments(&self) -> &[FileAttachment]

Returns all attachments that accompanied the request.

pub fn metadata(&self) -> &Value

Returns the raw metadata payload.

pub fn server(&self) -> &ServerHandle

Returns a server handle for outbound event operations.

pub fn attachment_summaries(&self) -> Vec<Value>

Returns a simplified JSON view of incoming attachments.

Trait Implementations

impl Clone for ApiContext

fn clone(&self) -> ApiContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.