Struct salvo_core::http::request::Request

source · [−]

pub struct Request { /* private fields */ }

Expand description

Represents an HTTP request.

Stores all the properties of the client’s request.

Implementations

source

impl Request

source

pub fn new() -> Request

Creates a new blank Request

source

pub fn uri(&self) -> &Uri

Returns a reference to the associated URI.

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

Returns a mutable reference to the associated URI.

pub fn method(&self) -> &Method

Returns a reference to the associated HTTP method.

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

Returns a mutable reference to the associated HTTP method.

pub fn version(&self) -> Version

Returns the associated version.

source

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

Returns a mutable reference to the associated version.

source

pub fn remote_addr(&self) -> Option<&SocketAddr>

Get request remote address.

source

pub fn headers(&self) -> &HeaderMap

Returns a reference to the associated header field map.

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

Returns a mutable reference to the associated header field map.

Examples

let mut req: Request = Request::default();
req.headers_mut().insert(HOST, HeaderValue::from_static("world"));
assert!(!req.headers().is_empty());

Get header with supplied name and try to parse to a ‘T’, returns None if failed or not found.

source

pub fn add_header<N, V>(
 &mut self,
 name: N,
 value: V,
 overwrite: bool
) -> Result<()>where
 N: IntoHeaderName,
 V: TryInto<HeaderValue>,

Modify a header for this request.

When overwrite is set to true, If the header is already present, the value will be replaced. When overwrite is set to false, The new header is always appended to the request, even if the header already exists.

source

pub fn with_header<N, V>(
 &mut self,
 name: N,
 value: V,
 overwrite: bool
) -> Result<&mut Self>where
 N: IntoHeaderName,
 V: TryInto<HeaderValue>,

Modify a header for this request.

When overwrite is set to true, If the header is already present, the value will be replaced. When overwrite is set to false, The new header is always appended to the request, even if the header already exists.

source

pub fn body(&self) -> Option<&Body>

Returns a reference to the associated HTTP body.

Examples

let req = Request::default();
assert!(req.body().is_some());

source

pub fn body_mut(&mut self) -> Option<&mut Body>

Returns a mutable reference to the associated HTTP body.

source

pub fn take_body(&mut self) -> Option<Body>

Take body form the request, and set the body to None in the request.

source

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

Examples

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

source

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

Returns a mutable reference to the associated extensions.

Examples

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

source

pub fn accept(&self) -> Vec<Mime>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

Get accept.

source

pub fn first_accept(&self) -> Option<Mime>

Get first accept.

source

pub fn content_type(&self) -> Option<Mime>

Get content type.

source

pub fn cookies(&self) -> &CookieJar

Available on crate feature cookie only.

Get CookieJar reference.

source

pub fn cookies_mut(&mut self) -> &mut CookieJar

Available on crate feature cookie only.

Get CookieJar mutable reference.

Available on crate feature cookie only.

Get Cookie from cookies.

source

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

Get params reference.

source

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

Get params mutable reference.

source

pub fn param<'de, T>(&'de self, key: &str) -> Option<T>where
T: Deserialize<'de>,

Get param value from params.

source

pub fn queries(&self) -> &MultiMap<String, String>

Get queries reference.

source

pub fn query<'de, T>(&'de self, key: &str) -> Option<T>where
T: Deserialize<'de>,

Get query value from queries.

source

pub async fn form<'de, T>(&'de mut self, key: &str) -> Option<T>where
T: Deserialize<'de>,

Get field data from form.

source

pub async fn form_or_query<'de, T>(&'de mut self, key: &str) -> Option<T>where
T: Deserialize<'de>,

Get field data from form, if key is not found in form data, then get from query.

source

pub async fn query_or_form<'de, T>(&'de mut self, key: &str) -> Option<T>where
T: Deserialize<'de>,

Get value from query, if key is not found in queries, then get from form.

source

pub async fn file<'a>(&'a mut self, key: &'a str) -> Option<&'a FilePart>

Get FilePart reference from request.

source

pub async fn first_file(&mut self) -> Option<&FilePart>

Get FilePart reference from request.

source

pub async fn files<'a>(&'a mut self, key: &'a str) -> Option<&'a Vec<FilePart>>

Get FilePart list reference from request.

source

pub async fn all_files(&mut self) -> Vec<&FilePart>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

Get FilePart list reference from request.

source

pub async fn payload(&mut self) -> Result<&Vec<u8>, ParseError>

Get request payload.

*Notice: This method takes body.

source

pub async fn form_data(&mut self) -> Result<&FormData, ParseError>

Get FormData reference from request.

*Notice: This method takes body.

source

pub async fn extract<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Extractible<'de>,

Extract request as type T from request’s different parts.

source

pub async fn extract_with_metadata<'de, T>(
 &'de mut self,
 metadata: &'de Metadata
) -> Result<T, ParseError>where
 T: Deserialize<'de>,

Extract request as type T from request’s different parts.

source

pub fn parse_params<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

Parse url params as type T from request.

source

pub fn parse_queries<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

Parse queries as type T from request.

source

pub fn parse_headers<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

Parse headers as type T from request.

source

pub fn parse_cookies<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

Available on crate feature cookie only.

Parse cookies as type T from request.

source

pub async fn parse_json<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

Parse json body as type T from request.

source

pub async fn parse_form<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

Parse form body as type T from request.

source

pub async fn parse_body<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

Parse json body or form body as type T from request.

Trait Implementations

source

impl Debug for Request

source

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

Formats the value using the given formatter. Read more

source

impl Default for Request

source

fn default() -> Request

Returns the “default value” for a type. Read more

source

impl From<Request<Body>> for Request

source

fn from(req: Request<Body>) -> Self

Converts to this type from the input type.

Auto Trait Implementations

impl !RefUnwindSafe for Request

impl Send for Request

impl Sync for Request

impl Unpin for Request

impl !UnwindSafe for Request

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,

fn implicit(
 self,
 class: Class,
 constructed: bool,
 tag: u32
) -> TaggedParser<'a, Implicit, Self, E>

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for Twhere
U: From<T>,

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

Struct salvo_core::http::request::Request

Implementations

impl Request

pub fn new() -> Request

pub fn uri(&self) -> &Uri

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

pub fn method(&self) -> &Method

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

pub fn version(&self) -> Version

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

pub fn remote_addr(&self) -> Option<&SocketAddr>

pub fn headers(&self) -> &HeaderMap

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

pub fn header<'de, T>(&'de self, key: impl AsHeaderName) -> Option<T>where T: Deserialize<'de>,

pub fn add_header<N, V>( &mut self, name: N, value: V, overwrite: bool) -> Result<()>where N: IntoHeaderName, V: TryInto<HeaderValue>,

pub fn with_header<N, V>( &mut self, name: N, value: V, overwrite: bool) -> Result<&mut Self>where N: IntoHeaderName, V: TryInto<HeaderValue>,

pub fn body(&self) -> Option<&Body>

pub fn body_mut(&mut self) -> Option<&mut Body>

pub fn take_body(&mut self) -> Option<Body>

pub fn extensions(&self) -> &Extensions

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

pub fn accept(&self) -> Vec<Mime>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where A: Allocator,

pub fn first_accept(&self) -> Option<Mime>

pub fn content_type(&self) -> Option<Mime>

pub fn cookies(&self) -> &CookieJar

pub fn cookies_mut(&mut self) -> &mut CookieJar

pub fn cookie<T>(&self, name: T) -> Option<&Cookie<'static>>where T: AsRef<str>,

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

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

pub fn param<'de, T>(&'de self, key: &str) -> Option<T>where T: Deserialize<'de>,

pub fn queries(&self) -> &MultiMap<String, String>

pub fn query<'de, T>(&'de self, key: &str) -> Option<T>where T: Deserialize<'de>,

pub async fn form<'de, T>(&'de mut self, key: &str) -> Option<T>where T: Deserialize<'de>,

pub async fn form_or_query<'de, T>(&'de mut self, key: &str) -> Option<T>where T: Deserialize<'de>,

pub async fn query_or_form<'de, T>(&'de mut self, key: &str) -> Option<T>where T: Deserialize<'de>,

pub async fn file<'a>(&'a mut self, key: &'a str) -> Option<&'a FilePart>

pub async fn first_file(&mut self) -> Option<&FilePart>

pub async fn files<'a>(&'a mut self, key: &'a str) -> Option<&'a Vec<FilePart>>

pub async fn all_files(&mut self) -> Vec<&FilePart>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A>where A: Allocator,

pub async fn payload(&mut self) -> Result<&Vec<u8>, ParseError>

pub async fn form_data(&mut self) -> Result<&FormData, ParseError>

pub async fn extract<'de, T>(&'de mut self) -> Result<T, ParseError>where T: Extractible<'de>,

pub async fn extract_with_metadata<'de, T>( &'de mut self, metadata: &'de Metadata) -> Result<T, ParseError>where T: Deserialize<'de>,

pub fn parse_params<'de, T>(&'de mut self) -> Result<T, ParseError>where T: Deserialize<'de>,

pub fn parse_queries<'de, T>(&'de mut self) -> Result<T, ParseError>where T: Deserialize<'de>,

pub fn parse_headers<'de, T>(&'de mut self) -> Result<T, ParseError>where T: Deserialize<'de>,

pub fn parse_cookies<'de, T>(&'de mut self) -> Result<T, ParseError>where T: Deserialize<'de>,

pub async fn parse_json<'de, T>(&'de mut self) -> Result<T, ParseError>where T: Deserialize<'de>,

pub async fn parse_form<'de, T>(&'de mut self) -> Result<T, ParseError>where T: Deserialize<'de>,

pub async fn parse_body<'de, T>(&'de mut self) -> Result<T, ParseError>where T: Deserialize<'de>,

Trait Implementations

impl Debug for Request

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

impl Default for Request

fn default() -> Request

impl From<Request<Body>> for Request

fn from(req: Request<Body>) -> Self

Auto Trait Implementations

impl !RefUnwindSafe for Request

impl Send for Request

impl Sync for Request

impl Unpin for Request

impl !UnwindSafe for Request

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn header<'de, T>(&'de self, key: impl AsHeaderName) -> Option<T>where
T: Deserialize<'de>,

pub fn add_header<N, V>(
&mut self,
name: N,
value: V,
overwrite: bool
) -> Result<()>where
N: IntoHeaderName,
V: TryInto<HeaderValue>,

pub fn with_header<N, V>(
&mut self,
name: N,
value: V,
overwrite: bool
) -> Result<&mut Self>where
N: IntoHeaderName,
V: TryInto<HeaderValue>,

pub fn accept(&self) -> Vec<Mime>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

pub fn cookie<T>(&self, name: T) -> Option<&Cookie<'static>>where
T: AsRef<str>,

pub fn param<'de, T>(&'de self, key: &str) -> Option<T>where
T: Deserialize<'de>,

pub fn query<'de, T>(&'de self, key: &str) -> Option<T>where
T: Deserialize<'de>,

pub async fn form<'de, T>(&'de mut self, key: &str) -> Option<T>where
T: Deserialize<'de>,

pub async fn form_or_query<'de, T>(&'de mut self, key: &str) -> Option<T>where
T: Deserialize<'de>,

pub async fn query_or_form<'de, T>(&'de mut self, key: &str) -> Option<T>where
T: Deserialize<'de>,

pub async fn all_files(&mut self) -> Vec<&FilePart>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A>where A: Allocator,`

pub async fn extract<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Extractible<'de>,

pub async fn extract_with_metadata<'de, T>(
&'de mut self,
metadata: &'de Metadata
) -> Result<T, ParseError>where
T: Deserialize<'de>,

pub fn parse_params<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

pub fn parse_queries<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

pub fn parse_headers<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

pub fn parse_cookies<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

pub async fn parse_json<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

pub async fn parse_form<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

pub async fn parse_body<'de, T>(&'de mut self) -> Result<T, ParseError>where
T: Deserialize<'de>,

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

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,

fn implicit(
self,
class: Class,
constructed: bool,
tag: u32
) -> TaggedParser<'a, Implicit, Self, E>

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

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

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

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

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

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

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