Struct httparse::Request

pub struct Request<'headers, 'buf: 'headers> {
    pub method: Option<&'buf str>,
    pub path: Option<&'buf str>,
    pub version: Option<u8>,
    pub headers: &'headers mut [Header<'buf>],
}

A parsed Request.

The optional values will be None if a parse was not complete, and did not parse the associated property. This allows you to inspect the parts that could be parsed, before reading more, in case you wish to exit early.

Example

let buf = b"GET /404 HTTP/1.1\r\nHost:";
let mut headers = [httparse::EMPTY_HEADER; 16];
let mut req = httparse::Request::new(&mut headers);
let res = req.parse(buf).unwrap();
if res.is_partial() {
    match req.path {
        Some(ref path) => {
            // check router for path.
            // /404 doesn't exist? we could stop parsing
        },
        None => {
            // must read more and parse again
        }
    }
}

Fields

method: Option<&'buf str>

The request method, such as GET.

path: Option<&'buf str>

The request path, such as /about-us.

version: Option<u8>

The request version, such as HTTP/1.1.

headers: &'headers mut [Header<'buf>]

The request headers.

Implementations

impl<'h, 'b> Request<'h, 'b>

pub fn new(headers: &'h mut [Header<'b>]) -> Request<'h, 'b>

Creates a new Request, using a slice of headers you allocate.

pub fn parse_with_uninit_headers(
    &mut self,
    buf: &'b [u8],
    headers: &'h mut [MaybeUninit<Header<'b>>]
) -> Result<usize>

Try to parse a buffer of bytes into the Request, except use an uninitialized slice of Headers.

For more information, see parse

pub fn parse(&mut self, buf: &'b [u8]) -> Result<usize>

Try to parse a buffer of bytes into the Request.

Returns byte offset in buf to start of HTTP body.

Trait Implementations

impl<'headers, 'buf: 'headers> Debug for Request<'headers, 'buf>

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

Formats the value using the given formatter.

impl<'headers, 'buf: 'headers> PartialEq<Request<'headers, 'buf>> for Request<'headers, 'buf>

fn eq(&self, other: &Request<'headers, 'buf>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Request<'headers, 'buf>) -> bool

This method tests for !=.

impl<'headers, 'buf: 'headers> Eq for Request<'headers, 'buf>

impl<'headers, 'buf: 'headers> StructuralEq for Request<'headers, 'buf>

impl<'headers, 'buf: 'headers> StructuralPartialEq for Request<'headers, 'buf>