Skip to main content

Request

Struct Request 

Source
pub struct Request {
    pub method: String,
    pub path: String,
    pub version: String,
    pub headers: HashMap<String, String>,
}
Expand description

Represents a parsed HTTP/1.x request line and headers.

You receive this type after successful stream parsing. It is the primary request model used by the synchronous server path and shared response-generation helpers.

§Examples

use http_handle::request::Request;
use std::collections::HashMap;

let request = Request {
    method: "GET".to_string(),
    path: "/".to_string(),
    version: "HTTP/1.1".to_string(),
    headers: HashMap::new(),
};
assert_eq!(request.method(), "GET");

§Panics

This type does not panic on construction.

Fields§

§method: String

HTTP method of the request.

§path: String

Requested path.

§version: String

HTTP version of the request.

§headers: HashMap<String, String>

Parsed request headers (header-name lowercased).

Implementations§

Source§

impl Request

Source

pub fn from_stream(stream: &TcpStream) -> Result<Self, ServerError>

Parses a request line and headers from a TcpStream.

This method reads the first line of an HTTP request from the given TCP stream, parses it, and constructs a Request instance if the input is valid.

§Arguments
  • stream - A reference to the TcpStream from which the request will be read.
§Returns
  • Ok(Request) - If the request is valid and successfully parsed.
  • Err(ServerError) - If the request is malformed, cannot be read, or is invalid.
§Errors

This function returns a ServerError::InvalidRequest error if:

  • The request line is too long (exceeds MAX_REQUEST_LINE_LENGTH)
  • The request line does not contain exactly three parts
  • The HTTP method is not recognized
  • The request path does not start with a forward slash (except OPTIONS *)
  • The HTTP version is not supported (only HTTP/1.0 and HTTP/1.1 are accepted)
§Examples
use std::net::TcpStream;
use http_handle::request::Request;

let stream = TcpStream::connect("127.0.0.1:8080").expect("connect");
let parsed = Request::from_stream(&stream);
assert!(parsed.is_ok() || parsed.is_err());
§Panics

This function does not intentionally panic.

Source

pub fn method(&self) -> &str

Returns the HTTP method of the request.

§Returns

A string slice containing the HTTP method (e.g., “GET”, “POST”).

Source

pub fn path(&self) -> &str

Returns the requested path of the request.

§Returns

A string slice containing the requested path.

Source

pub fn version(&self) -> &str

Returns the HTTP version of the request.

§Returns

A string slice containing the HTTP version (e.g., “HTTP/1.1”).

Source

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

Returns the value of a header by case-insensitive name.

§Examples
use http_handle::request::Request;
use std::collections::HashMap;

let mut headers = HashMap::new();
headers.insert("content-type".to_string(), "text/plain".to_string());
let request = Request {
    method: "GET".to_string(),
    path: "/".to_string(),
    version: "HTTP/1.1".to_string(),
    headers,
};
assert_eq!(request.header("Content-Type"), Some("text/plain"));
§Panics

This function does not panic.

Source

pub fn headers(&self) -> &HashMap<String, String>

Returns all parsed headers.

Trait Implementations§

Source§

impl Clone for Request

Source§

fn clone(&self) -> Request

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Request

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Request

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Request

Source§

fn eq(&self, other: &Request) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Request

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more