Struct tide::Context

pub struct Context<State> { /* fields omitted */ }

Data associated with a request-response lifecycle.

The Context gives endpoints access to basic information about the incoming request, route parameters, and various ways of accessing the request's body.

Contexts also provide extensions, a type map primarily used for low-level communication between middleware and endpoints.

Methods

impl<State> Context<State>

pub fn method(&self) -> &Method

Access the request's HTTP method.

pub fn uri(&self) -> &Uri

Access the request's full URI method.

pub fn version(&self) -> Version

Access the request's HTTP version.

pub fn headers(&self) -> &HeaderMap

Access the request's headers.

pub fn request(&self) -> &Request

Access the entire request.

pub fn state(&self) -> &State

Access app-global data.

pub fn param<T: FromStr>(&self, key: &str) -> Result<T, T::Err>

Extract and parse a route parameter by name.

Returns the results of parsing the parameter according to the inferred output type T.

The name should not include the leading : or the trailing * (if any).

Errors

Yields an Err if the parameter was found but failed to parse as an instance of type T.

Panics

Panic if key is not a parameter for the route.

pub async fn body_bytes<'_>(&'_ mut self) -> Result<Vec<u8>>

Reads the entire request body into a byte buffer.

This method can be called after the body has already been read, but will produce an empty buffer.

Errors

Any I/O error encountered while reading the body is immediately returned as an Err.

pub async fn body_string<'_>(&'_ mut self) -> Result<String>

Reads the entire request body into a string.

This method can be called after the body has already been read, but will produce an empty buffer.

Errors

Any I/O error encountered while reading the body is immediately returned as an Err.

If the body cannot be interpreted as valid UTF-8, an Err is returned.

pub async fn body_json<'_, T: DeserializeOwned>(&'_ mut self) -> Result<T>

Reads and deserialized the entire request body via json.

Errors

Any I/O error encountered while reading the body is immediately returned as an Err.

If the body cannot be interpreted as valid json for the target type T, an Err is returned.

pub fn take_body(&mut self) -> Body

Remove ownership of the request body, replacing it with an empty body.

Used primarily for working directly with the body stream.

pub fn extensions(&self) -> &Extensions

Access the extensions to the context.

pub fn extensions_mut(&mut self) -> &mut Extensions

Mutably access the extensions to the context.

Trait Implementations

impl<State> ContextExt for Context<State>

fn get_cookie(
    &mut self,
    name: &str
) -> Result<Option<Cookie<'static>>, StringError>

returns a Cookie by name of the cookie

fn set_cookie(&mut self, cookie: Cookie<'static>) -> Result<(), StringError>

Add cookie to the cookie jar

fn remove_cookie(&mut self, cookie: Cookie<'static>) -> Result<(), StringError>

Removes the cookie. This instructs the CookiesMiddleware to send a cookie with empty value in the response.

impl<State: Send + Sync + 'static> ExtractForms for Context<State>

fn body_form<T: DeserializeOwned>(
    &mut self
) -> Pin<Box<dyn Future<Output = EndpointResult<T>> + Send + 'static>>

Asynchronously extract the entire body as a single form.

fn body_multipart(
    &mut self
) -> Pin<Box<dyn Future<Output = EndpointResult<Multipart<Cursor<Vec<u8>>>>> + Send + 'static>>

Asynchronously extract the entire body as a multipart form.

impl<'de, Data> ContextExt<'de> for Context<Data>

fn url_query<T: Deserialize<'de>>(&'de self) -> Result<T, Error>

impl<State: Debug> Debug for Context<State>

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

Formats the value using the given formatter.