Struct saphir::SyncRequest

pub struct SyncRequest { /* fields omitted */ }

A Structure which represent an http request with a fully loaded body

Methods

impl SyncRequest

pub fn new(head: ReqParts, body: Vec<u8>) -> SyncRequest

Construct a new Request.

pub fn head(&self) -> &ReqParts

Returns a reference to this request head.

pub fn method(&self) -> &Method

Returns a reference to the associated HTTP method.

Examples

let request: Request<()> = Request::default();
assert_eq!(*request.method(), Method::GET);

pub fn method_mut(&mut self) -> &mut Method

Returns a mutable reference to the associated HTTP method.

Examples

let mut request: Request<()> = Request::default();
*request.method_mut() = Method::PUT;
assert_eq!(*request.method(), Method::PUT);

pub fn uri(&self) -> &Uri

Returns a reference to the associated URI.

Examples

let request: Request<()> = Request::default();
assert_eq!(*request.uri(), *"/");

pub fn uri_mut(&mut self) -> &mut Uri

Returns a mutable reference to the associated URI.

Examples

let mut request: Request<()> = Request::default();
*request.uri_mut() = "/hello".parse().unwrap();
assert_eq!(*request.uri(), *"/hello");

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

pub fn version(&self) -> Version

Returns the associated version.

Examples

let request: Request<()> = Request::default();
assert_eq!(request.version(), Version::HTTP_11);

pub fn version_mut(&mut self) -> &mut Version

Returns a mutable reference to the associated version.

Examples

let mut request: Request<()> = Request::default();
*request.version_mut() = Version::HTTP_2;
assert_eq!(request.version(), Version::HTTP_2);

pub fn headers_map(&self) -> &HeaderMap<HeaderValue>

Returns a reference to the associated header field map.

Examples

use saphir::*;
 
let request: Request<()> = Request::default();
assert!(request.headers().is_empty());

pub fn headers_map_mut(&mut self) -> &mut HeaderMap<HeaderValue>

Returns a mutable reference to the associated header field map.

Examples

use saphir::*;
use saphir::header::*;
 
let mut request: Request<()> = Request::default();
request.headers_mut().insert(HOST, HeaderValue::from_static("world"));
assert!(!request.headers().is_empty());

pub fn parsed_header(&self) -> Headers

Clone the HeaderMap and convert it to a more dev-friendly Headers struct

pub fn insert_parsed_headers(&mut self, headers: Headers)

Insert a dev-friendly Headers to the HeaderMap

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

Examples

let request: Request<()> = Request::default();
assert!(request.extensions().get::<i32>().is_none());

pub fn extensions_mut(&mut self) -> &mut Extensions

Returns a mutable reference to the associated extensions.

Examples

let mut request: Request<()> = Request::default();
request.extensions_mut().insert("hello");
assert_eq!(request.extensions().get(), Some(&"hello"));

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn body(&self) -> &Vec<u8>

Returns a reference to the associated HTTP body.

Examples

let request: Request<String> = Request::default();
assert!(request.body().is_empty());

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn body_mut(&mut self) -> &mut Vec<u8>

Returns a mutable reference to the associated HTTP body.

Examples

let mut request: Request<String> = Request::default();
request.body_mut().push_str("hello world");
assert!(!request.body().is_empty());

pub fn cookies(&self) -> Cookies

Get the cookies sent by the browsers

pub fn cookies_mut(&mut self) -> CookiesMut

Get the cookies sent by the browsers in a mutable way

Trait Implementations

impl Debug for SyncRequest

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

Formats the value using the given formatter.