Struct HttpRequest 

pub struct HttpRequest {
    pub method: String,
    pub path: String,
    pub headers: HashMap<String, String>,
    pub body: Vec<u8>,
    pub path_params: HashMap<String, String>,
    pub query_params: HashMap<String, String>,
    pub extensions: Extensions,
    /* private fields */
}

HTTP request wrapper

The body is stored as Vec<u8> for backwards compatibility. For zero-copy body handling, use body_bytes() or set_body_bytes().

Fields

method: String

path: String

headers: HashMap<String, String>

body: Vec<u8>

Request body as raw bytes.

For zero-copy access, use body_bytes() to get a Bytes view, or use RequestBody for efficient body handling.

path_params: HashMap<String, String>

query_params: HashMap<String, String>

extensions: Extensions

Type-safe extensions for storing application state.

Use this to pass typed data to handlers without DI container lookups. Access via the State<T> extractor for zero-cost state retrieval.

Implementations

impl HttpRequest

pub fn new(method: String, path: String) -> Self

pub fn with_extensions_capacity( method: String, path: String, capacity: usize, ) -> Self

Create a new request with pre-allocated extensions capacity.

pub fn with_bytes_body(method: String, path: String, body: Bytes) -> Self

Create a new request with a Bytes body (zero-copy).

This is the most efficient way to create a request from Hyper’s body, as it avoids copying the body data.

pub fn set_body_bytes(&mut self, bytes: Bytes)

Set the body using Bytes (zero-copy).

This avoids copying the body data from Hyper.

pub fn body_bytes(&self) -> Bytes

Get the body as Bytes (zero-copy if stored as Bytes).

If the body was set via set_body_bytes() or with_bytes_body(), this returns a clone of the Bytes (O(1) reference count increment). Otherwise, it creates Bytes from the Vec.

pub fn body_ref(&self) -> &[u8]

Get a reference to the body bytes.

Returns a reference to the body data without copying.

pub fn request_body(&self) -> RequestBody

Get the body as a RequestBody (zero-copy wrapper).

pub fn has_bytes_body(&self) -> bool

Check if the body is using zero-copy Bytes storage.

pub fn set_body(&mut self, body: Vec<u8>)

Set the body from a Vec.

pub fn from_parts( method: String, path: String, headers: HashMap<String, String>, body: Vec<u8>, path_params: HashMap<String, String>, query_params: HashMap<String, String>, ) -> Self

Create a request from all parts (for compatibility in tests).

pub fn insert_extension<T: Send + Sync + 'static>(&mut self, value: T)

Insert a typed value into request extensions.

Use this to pass application state to handlers.

Example

let mut request = HttpRequest::new("GET".into(), "/".into());
request.insert_extension(app_state);

pub fn insert_extension_arc<T: Send + Sync + 'static>(&mut self, value: Arc<T>)

Insert an Arc-wrapped value into request extensions.

This is more efficient when you already have an Arc.

pub fn extension<T: Send + Sync + 'static>(&self) -> Option<&T>

Get a reference to a typed extension.

Returns None if no value of this type exists.

pub fn extension_arc<T: Send + Sync + 'static>(&self) -> Option<Arc<T>>

Get an Arc reference to a typed extension.

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

Parse the request body as JSON.

With the simd-json feature enabled, this uses SIMD-accelerated parsing which can be 2-3x faster on modern x86_64 CPUs.

Example

let user: CreateUser = request.json()?;

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

Parse URL-encoded form data

pub fn form_map(&self) -> Result<HashMap<String, String>, Error>

Parse URL-encoded form data into a HashMap

pub fn multipart(&self) -> Result<Vec<FormField>, Error>

Parse multipart form data

pub fn param(&self, name: &str) -> Option<&String>

Get a path parameter by name

pub fn query(&self, name: &str) -> Option<&String>

Get a query parameter by name

Trait Implementations

impl Clone for HttpRequest

fn clone(&self) -> HttpRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpRequest

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

Formats the value using the given formatter.

impl FromHttpRequest for HttpRequest

fn from_http_request(req: Request<Bytes>) -> Self

Create from http crate Request.

impl FromRequest for HttpRequest

fn from_request(request: &HttpRequest) -> Result<Self, Error>

Extract data from the request

impl IntoHttpRequest for HttpRequest

fn into_http_request(self) -> Request<Bytes>

Convert to http crate Request.

impl<H, Fut, E1> Service<HttpRequest> for ExtractorHandlerService<H, (E1,)>

where H: Fn(E1) -> Fut + Clone + Send + Sync + 'static, Fut: Future<Output = Result<HttpResponse, Error>> + Send + 'static, E1: Extract + Send + 'static,

type Response = HttpResponse

Response type.

type Error = Error

Error type.

type Future = Pin<Box<dyn Future<Output = Result<HttpResponse, Error>> + Send>>

Future type.

fn call(&self, req: HttpRequest) -> Self::Future

Process a request.

impl<H, Fut> Service<HttpRequest> for HandlerService<H, ()>

where H: Fn() -> Fut + Clone + Send + Sync + 'static, Fut: Future<Output = Result<HttpResponse, Error>> + Send + 'static,

type Response = HttpResponse

Response type.

type Error = Error

Error type.

type Future = Pin<Box<dyn Future<Output = Result<HttpResponse, Error>> + Send>>

Future type.

fn call(&self, _req: HttpRequest) -> Self::Future

Process a request.

impl<H, Fut> Service<HttpRequest> for HandlerService<H, (HttpRequest,)>

where H: Fn(HttpRequest) -> Fut + Clone + Send + Sync + 'static, Fut: Future<Output = Result<HttpResponse, Error>> + Send + 'static,

type Response = HttpResponse

Response type.

type Error = Error

Error type.

type Future = Pin<Box<dyn Future<Output = Result<HttpResponse, Error>> + Send>>

Future type.

fn call(&self, req: HttpRequest) -> Self::Future

Process a request.

impl<S> Service<HttpRequest> for LoggingService<S>

where S: Service<HttpRequest, Response = HttpResponse, Error = Error> + Clone + Send + Sync + 'static, S::Future: Send,

type Response = HttpResponse

Response type.

type Error = Error

Error type.

type Future = Pin<Box<dyn Future<Output = Result<HttpResponse, Error>> + Send>>

Future type.

fn call(&self, req: HttpRequest) -> Self::Future

Process a request.

impl<S> Service<HttpRequest> for RequestIdService<S>

where S: Service<HttpRequest, Response = HttpResponse, Error = Error> + Clone + Send + Sync + 'static, S::Future: Send,

type Response = HttpResponse

Response type.

type Error = Error

Error type.

type Future = Pin<Box<dyn Future<Output = Result<HttpResponse, Error>> + Send>>

Future type.

fn call(&self, req: HttpRequest) -> Self::Future

Process a request.

impl<S> Service<HttpRequest> for TimeoutService<S>

where S: Service<HttpRequest, Response = HttpResponse, Error = Error> + Clone + Send + Sync + 'static, S::Future: Send,

type Response = HttpResponse

Response type.

type Error = Error

Error type.

type Future = Pin<Box<dyn Future<Output = Result<HttpResponse, Error>> + Send>>

Future type.

fn call(&self, req: HttpRequest) -> Self::Future

Process a request.