Skip to main content

Request

Struct Request 

Source
pub struct Request {
Show 14 fields pub method: Method, pub uri: Uri, pub headers: HeaderMap, pub body: Body, pub params: HashMap<String, String>, pub query: HashMap<String, String>, pub json_body: Option<Value>, pub form_data_cache: Option<HashMap<String, String>>, pub request_id: String, pub user_id: Option<String>, pub user_roles: Vec<String>, pub session: Option<SessionHandle>, pub extensions: Extensions, pub remote_addr: Option<SocketAddr>,
}

Fields§

§method: Method§uri: Uri§headers: HeaderMap§body: Body§params: HashMap<String, String>§query: HashMap<String, String>§json_body: Option<Value>§form_data_cache: Option<HashMap<String, String>>§request_id: String§user_id: Option<String>§user_roles: Vec<String>§session: Option<SessionHandle>§extensions: Extensions§remote_addr: Option<SocketAddr>

Implementations§

Source§

impl Request

Source

pub async fn from_hyper( req: HyperRequest<Body>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

Source

pub async fn from_hyper_with_addr( req: HyperRequest<Body>, remote_addr: Option<SocketAddr>, ) -> Result<Self, Box<dyn Error + Send + Sync>>

Source

pub async fn json(&mut self) -> Result<Value, Box<dyn Error + Send + Sync>>

Source

pub async fn form_data( &mut self, ) -> Result<HashMap<String, String>, Box<dyn Error + Send + Sync>>

Source

pub fn request_id(&self) -> &str

Return the correlation ID assigned to this request.

Source

pub const fn request_id_header() -> &'static str

Header name used for request correlation.

Source

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

Source

pub fn query_param(&self, key: &str) -> Option<&String>

Source

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

Shorthand to get a header value as a string

Source

pub fn is_json(&self) -> bool

Check if the request Content-Type is JSON

Source

pub fn is_ajax(&self) -> bool

Check if the request is an AJAX/XHR request

Source

pub async fn body_bytes( &mut self, ) -> Result<Vec<u8>, Box<dyn Error + Send + Sync>>

Get the raw body bytes without consuming the body stream

Trait Implementations§

Source§

impl Debug for Request

Source§

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

Formats the value using the given formatter. Read more

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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