Struct actix_web::HttpRequest

pub struct HttpRequest { /* fields omitted */ }

An HTTP Request

Methods

impl HttpRequest

fn new(method: Method, uri: Uri, version: Version, headers: HeaderMap) -> Self

Construct a new Request.

fn extensions(&mut self) -> &mut Extensions

Protocol extensions.

fn uri(&self) -> &Uri

Read the Request Uri.

fn method(&self) -> &Method

Read the Request method.

fn version(&self) -> Version

Read the Request Version.

fn headers(&self) -> &HeaderMap

Read the Request Headers.

fn path(&self) -> &str

The target path of this Request.

fn query(&self) -> Parse

Return a new iterator that yields pairs of Cow<str> for query parameters

fn query_string(&self) -> &str

The query string in the URL.

E.g., id=10

fn cookies(&self) -> &Vec<Cookie<'static>>

Return request cookies.

fn cookie(&self, name: &str) -> Option<&Cookie>

Return request cookie.

fn load_cookies(&mut self) -> Result<&Vec<Cookie>, CookieParseError>

Load cookies

fn match_info(&self) -> &Params

Get a reference to the Params object. Params is a container for url parameters. Route supports glob patterns: * for a single wildcard segment and :param for matching storing that segment of the request url in the Params object.

fn set_match_info(&mut self, params: Params)

Set request Params.

fn keep_alive(&self) -> bool

Checks if a connection should be kept alive.

fn chunked(&self) -> Result<bool, ParseError>

Check if request has chunked transfer encoding

fn range(&self, size: u64) -> Result<Vec<HttpRange>, HttpRangeParseError>

Parses Range HTTP header string as per RFC 2616. size is full size of response (file).

fn multipart(&self, payload: Payload) -> Result<Multipart, MultipartError>

Return stream to process BODY as multipart.

Content-type: multipart/form-data;

fn urlencoded(&self, payload: Payload) -> Result<UrlEncoded, Payload>

Parse application/x-www-form-urlencoded encoded body. Return UrlEncoded future. It resolves to a HashMap<String, String> which contains decoded parameters.

Returns error:

• content type is not application/x-www-form-urlencoded
• transfer encoding is chunked.
• content-length is greater than 256k

Trait Implementations

impl Debug for HttpRequest

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

Formats the value using the given formatter.