Struct tide::Request

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

An HTTP request.

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

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

Implementations

impl<State> Request<State>

#[must_use]pub fn method(&self) -> Method

Access the request's HTTP method.

Examples

use tide::Request;

let mut app = tide::new();
app.at("/").get(|req: Request<()>| async move {
    assert_eq!(req.method(), http_types::Method::Get);
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

#[must_use]pub fn url(&self) -> &Url

Access the request's full URI method.

Examples

use tide::Request;

let mut app = tide::new();
app.at("/").get(|req: Request<()>| async move {
    assert_eq!(req.url(), &"/".parse::<tide::http::Url>().unwrap());
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

#[must_use]pub fn version(&self) -> Option<Version>

Access the request's HTTP version.

Examples

use tide::Request;

let mut app = tide::new();
app.at("/").get(|req: Request<()>| async move {
    assert_eq!(req.version(), Some(http_types::Version::Http1_1));
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

#[must_use]pub fn peer_addr(&self) -> Option<&str>

Get the peer socket address for the underlying transport, if that information is available for this request.

#[must_use]pub fn local_addr(&self) -> Option<&str>

Get the local socket address for the underlying transport, if that information is available for this request.

#[must_use]pub fn remote(&self) -> Option<&str>

Get the remote address for this request.

This is determined in the following priority:

1. Forwarded header for key
2. The first X-Forwarded-For header
3. Peer address of the transport

#[must_use]pub fn host(&self) -> Option<&str>

Get the destination host for this request.

This is determined in the following priority:

1. Forwarded header host key
2. The first X-Forwarded-Host header
3. Host header
4. URL domain, if any

#[must_use]pub fn content_type(&self) -> Option<Mime>

Get the request content type as a Mime.

This gets the request Content-Type header.

Read more on MDN

#[must_use]pub fn header(&self, key: impl Into<HeaderName>) -> Option<&HeaderValues>

Get an HTTP header.

Examples

use tide::Request;

let mut app = tide::new();
app.at("/").get(|req: Request<()>| async move {
    assert_eq!(req.header("X-Forwarded-For").unwrap(), "127.0.0.1");
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

pub fn header_mut(
    &mut self,
    name: impl Into<HeaderName>
) -> Option<&mut HeaderValues>

Get a mutable reference to a header.

pub fn insert_header(
    &mut self,
    name: impl Into<HeaderName>,
    values: impl ToHeaderValues
) -> Option<HeaderValues>

Set an HTTP header.

pub fn append_header(
    &mut self,
    name: impl Into<HeaderName>,
    values: impl ToHeaderValues
)

Append a header to the headers.

Unlike insert this function will not override the contents of a header, but insert a header if there aren't any. Or else append to the existing list of headers.

pub fn remove_header(
    &mut self,
    name: impl Into<HeaderName>
) -> Option<HeaderValues>

Remove a header.

#[must_use]pub fn iter(&self) -> Iter<'_>

An iterator visiting all header pairs in arbitrary order.

#[must_use]pub fn iter_mut(&mut self) -> IterMut<'_>

An iterator visiting all header pairs in arbitrary order, with mutable references to the values.

#[must_use]pub fn header_names(&self) -> Names<'_>

An iterator visiting all header names in arbitrary order.

#[must_use]pub fn header_values(&self) -> Values<'_>

An iterator visiting all header values in arbitrary order.

#[must_use]pub fn ext<T: Send + Sync + 'static>(&self) -> Option<&T>

Get a request extension value.

#[must_use]pub fn ext_mut<T: Send + Sync + 'static>(&mut self) -> Option<&mut T>

Get a mutable reference to value stored in request extensions.

pub fn set_ext<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T>

Set a request extension value.

#[must_use]pub fn state(&self) -> &State

Access application scoped state.

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

Extract and parse a route parameter by name.

Returns the parameter as a &str, borrowed from this Request.

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

Errors

An error is returned if key is not a valid parameter for the route.

Examples

use tide::{Request, Result};

async fn greet(req: Request<()>) -> Result<String> {
    let name = req.param("name").unwrap_or("world");
    Ok(format!("Hello, {}!", name))
}

let mut app = tide::new();
app.at("/hello").get(greet);
app.at("/hello/:name").get(greet);
app.listen("127.0.0.1:8080").await?;

pub fn query<T: DeserializeOwned>(&self) -> Result<T>

Parse the URL query component into a struct, using serde_qs. To get the entire query as an unparsed string, use request.url().query()

use tide::prelude::*;
let mut app = tide::new();

#[derive(Deserialize)]
#[serde(default)]
struct Page {
    size: u8,
    offset: u8,
}
impl Default for Page {
    fn default() -> Self {
        Self {
            size: 25,
            offset: 0,
        }
    }
}
app.at("/pages").post(|req: tide::Request<()>| async move {
    let page: Page = req.query()?;
    Ok(format!("page {}, with {} items", page.offset, page.size))
});

app.listen("localhost:8000").await?;

// $ curl localhost:8000/pages
// page 0, with 25 items

// $ curl localhost:8000/pages?offset=1
// page 1, with 25 items

// $ curl localhost:8000/pages?offset=2&size=50
// page 2, with 50 items

// $ curl localhost:8000/pages?size=5000
// failed with reason: number too large to fit in target type

// $ curl localhost:8000/pages?size=all
// failed with reason: invalid digit found in string

pub fn set_body(&mut self, body: impl Into<Body>)

Set the body reader.

pub fn take_body(&mut self) -> Body

Take the request body as a Body.

This method can be called after the body has already been taken or read, but will return an empty Body.

This is useful for consuming the body via an AsyncReader or AsyncBufReader.

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.

Examples

use tide::Request;

let mut app = tide::new();
app.at("/").get(|mut req: Request<()>| async move {
    let _body: Vec<u8> = req.body_bytes().await.unwrap();
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

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.

Examples

use tide::Request;

let mut app = tide::new();
app.at("/").get(|mut req: Request<()>| async move {
    let _body: String = req.body_string().await.unwrap();
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

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 async fn body_form<T: DeserializeOwned, '_>(&'_ mut self) -> Result<T>

Parse the request body as a form.

use tide::prelude::*;
let mut app = tide::new();

#[derive(Deserialize)]
struct Animal {
  name: String,
  legs: u8
}

app.at("/").post(|mut req: tide::Request<()>| async move {
    let animal: Animal = req.body_form().await?;
    Ok(format!(
        "hello, {}! i've put in an order for {} shoes",
        animal.name, animal.legs
    ))
});

app.listen("localhost:8000").await?;

// $ curl localhost:8000/orders/shoes -d "name=chashu&legs=4"
// hello, chashu! i've put in an order for 4 shoes

// $ curl localhost:8000/orders/shoes -d "name=mary%20millipede&legs=750"
// number too large to fit in target type

#[must_use]pub fn cookie(&self, name: &str) -> Option<Cookie<'static>>

returns a Cookie by name of the cookie.

pub fn session(&self) -> &Session

Retrieves a reference to the current session.

Panics

This method will panic if a tide::sessions:SessionMiddleware has not been run.

pub fn session_mut(&mut self) -> &mut Session

Retrieves a mutable reference to the current session.

Panics

This method will panic if a tide::sessions:SessionMiddleware has not been run.

#[must_use]pub fn len(&self) -> Option<usize>

Get the length of the body stream, if it has been set.

This value is set when passing a fixed-size object into as the body. E.g. a string, or a buffer. Consumers of this API should check this value to decide whether to use Chunked encoding, or set the response length.

#[must_use]pub fn is_empty(&self) -> Option<bool>

Returns true if the request has a set body stream length of zero, false otherwise.

Trait Implementations

impl<State> AsMut<Headers> for Request<State>

fn as_mut(&mut self) -> &mut Headers

Performs the conversion.

impl<State> AsMut<Request> for Request<State>

fn as_mut(&mut self) -> &mut Request

Performs the conversion.

impl<State> AsRef<Headers> for Request<State>

fn as_ref(&self) -> &Headers

Performs the conversion.

impl<State> AsRef<Request> for Request<State>

fn as_ref(&self) -> &Request

Performs the conversion.

impl<State> AsyncRead for Request<State>

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

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

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

Formats the value using the given formatter.

impl<State, '_> Index<&'_ str> for Request<State>

type Output = HeaderValues

The returned type after indexing.

fn index(&self, name: &str) -> &HeaderValues

Returns a reference to the value corresponding to the supplied name.

Panics

Panics if the name is not present in Request.

impl<State> Index<HeaderName> for Request<State>

type Output = HeaderValues

The returned type after indexing.

fn index(&self, name: HeaderName) -> &HeaderValues

Returns a reference to the value corresponding to the supplied name.

Panics

Panics if the name is not present in Request.

impl<State: Default> Into<Request<State>> for Request

fn into(self) -> Request<State>

Performs the conversion.

impl<State> Into<Request> for Request<State>

fn into(self) -> Request

Performs the conversion.

impl<State: Clone + Send + Sync + 'static> Into<Response> for Request<State>

fn into(self) -> Response

Performs the conversion.

impl<State> IntoIterator for Request<State>

type Item = (HeaderName, HeaderValues)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Returns a iterator of references over the remaining items.

impl<'a, State> IntoIterator for &'a Request<State>

type Item = (&'a HeaderName, &'a HeaderValues)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, State> IntoIterator for &'a mut Request<State>

type Item = (&'a HeaderName, &'a mut HeaderValues)

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'__pin, State> Unpin for Request<State> where
    __Origin<'__pin, State>: Unpin,