Struct Request 

pub struct Request<State = ()> { /* private fields */ }

Implementations

impl<State> Request<State>

pub fn method(&self) -> &Method

Returns a reference to the request’s method.

pub fn uri(&self) -> &Uri

Returns a reference to the request’s URI.

pub fn version(&self) -> Version

Returns the HTTP version that was used to make the request.

pub fn headers(&self) -> &HeaderMap

Returns a reference to the request’s headers.

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

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

Returns a mutable reference to the associated extensions.

pub fn param<'b>(&self, name: &'b str) -> PathParam<'_, 'b>

Returns a convenient wrapper around an optional reference to the path parameter in the request’s uri with the provided name.

Example

use via::{Next, Request, Response};

async fn hello(request: Request, _: Next) -> via::Result {
    let name = request.param("name").into_result()?;
    Response::build().text(format!("Hello, {}!", name))
}

pub fn query<'b>(&self, name: &'b str) -> QueryParam<'_, 'b>

Returns a convenient wrapper around an optional references to the query parameters in the request’s uri with the provided name.

Example

use via::{Next, Request, Response};

async fn hello(request: Request, _: Next) -> via::Result {
    // Attempt to parse the first query parameter named `n` to a `usize`
    // no greater than 1000. If the query parameter doesn't exist or
    // can't be converted to a `usize`, default to 1.
    let n = request.query("n").first().parse().unwrap_or(1).min(1000);

    // Get a reference to the path parameter `name` from the request uri.
    let name = request.param("name").into_result()?;

    // Create a greeting message with the provided `name`.
    let message = format!("Hello, {}!\n", name);

    // Send a response with our greeting message, repeated `n` times.
    Response::build().text(message.repeat(n))
}

pub fn header<K>(&self, key: K) -> Result<Option<&str>, Error>

where K: AsHeaderName,

Returns a result that contains an Option<&str> with the header value associated with the provided key.

Errors

Status Code: 400

If the header value associated with key contains a char that is not considered to be visible ascii.

pub fn cookies(&self) -> &CookieJar

Returns reference to the cookies associated with the request.

pub fn state(&self) -> &Arc<State>

Returns a reference to an Arc that contains the state argument that was passed as an argument to the App constructor.

pub fn map<U, F>(self, map: F) -> Self

where F: FnOnce(RequestBody) -> U, U: Body<Data = Bytes, Error = BoxError> + Send + Sync + 'static,

Consumes the request returning a new request with body mapped to the return type of the provided closure.

pub fn into_parts(self) -> (RequestHead<State>, RequestBody)

Consumes the request and returns a tuple containing the head and body.

pub async fn into_future(self) -> Result<DataAndTrailers, Error>

Consumes the request and returns a future that resolves with the data in the body.

Trait Implementations

impl<State: Debug> Debug for Request<State>

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

Formats the value using the given formatter.

impl<State> Pipe for Request<State>

fn pipe(self, builder: ResponseBuilder) -> Result<Response, Error>