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.

Examples

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

source

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

Returns a mutable reference to the associated URI.

Examples

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

source

pub fn method(&self) -> &Method

Returns a reference to the associated HTTP method.

Examples

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

source

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);

source

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.

Examples

let req = Request::default();
assert!(req.headers().is_empty());

source

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 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 frist_accept(&self) -> Option<Mime>

Get first accept.

source

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

Get content type.

source

pub fn cookies(&self) -> &CookieJar

Get CookieJar reference.

source

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

Get CookieJar mutable reference.

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<T>(&self, key: &str) -> Option<T> where
T: FromStr,

Get param value from params.

source

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

Get queries reference.

source

pub fn query<F>(&self, key: &str) -> Option<F> where
F: FromStr,

Get query value from queries.

source

pub async fn form<F>(&mut self, key: &str) -> Option<F> where
F: FromStr,

Get field data from form.

source

pub async fn file(&mut self, key: &str) -> Option<&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(&mut self, key: &str) -> Option<&Vec<FilePart>>

Get FilePart list reference from request.

source

pub async fn all_files(&mut self) -> Vec<&FilePart>

Get FilePart list reference from request.

source

pub async fn form_or_query<F>(&mut self, key: &str) -> Option<F> where
F: FromStr,

Get value from form first if not found then get from query.

source

pub async fn query_or_form<F>(&mut self, key: &str) -> Option<F> where
F: FromStr,

Get value from query first if not found then get from form.

source

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

Get request payload.

source

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

Get FormData reference from request.

source

pub async fn read_text(&mut self) -> Result<&str, ParseError>

Read body as text from request.

source

pub async fn read_from_text<T>(&mut self) -> Result<T, ParseError> where
T: FromStr,

Read body as type T from request.

source

pub async fn read_from_json<T>(&mut self) -> Result<T, ParseError> where
T: DeserializeOwned,

Read body as type T from request.

source

pub async fn read_from_form<T>(&mut self) -> Result<T, ParseError> where
T: DeserializeOwned,

Read body as type T from request.

source

pub async fn read<T>(&mut self) -> Result<T, ParseError> where
T: DeserializeOwned,

Read 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 T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T> AsTaggedExplicit<'a> for T where
T: 'a,

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

impl<'a, T> AsTaggedImplicit<'a> for T where
T: 'a,

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

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
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 T where
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 T where
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 T where
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 T where
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<T>(&self, key: &str) -> Option<T> where T: FromStr,

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 frist_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<T>(&self, key: &str) -> Option<T> where T: FromStr,

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

pub fn query<F>(&self, key: &str) -> Option<F> where F: FromStr,

pub async fn form<F>(&mut self, key: &str) -> Option<F> where F: FromStr,

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

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

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

pub async fn all_files(&mut self) -> Vec<&FilePart>

pub async fn form_or_query<F>(&mut self, key: &str) -> Option<F> where F: FromStr,

pub async fn query_or_form<F>(&mut self, key: &str) -> Option<F> where F: FromStr,

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

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

pub async fn read_text(&mut self) -> Result<&str, ParseError>

pub async fn read_from_text<T>(&mut self) -> Result<T, ParseError> where T: FromStr,

pub async fn read_from_json<T>(&mut self) -> Result<T, ParseError> where T: DeserializeOwned,

pub async fn read_from_form<T>(&mut self) -> Result<T, ParseError> where T: DeserializeOwned,

pub async fn read<T>(&mut self) -> Result<T, ParseError> where T: DeserializeOwned,

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 T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<'a, T> AsTaggedExplicit<'a> for T where T: 'a,

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

impl<'a, T> AsTaggedImplicit<'a> for T where T: 'a,

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

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

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where 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 T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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<T>(&self, key: &str) -> Option<T> where
T: FromStr,

pub fn query<F>(&self, key: &str) -> Option<F> where
F: FromStr,

pub async fn form<F>(&mut self, key: &str) -> Option<F> where
F: FromStr,

pub async fn form_or_query<F>(&mut self, key: &str) -> Option<F> where
F: FromStr,

pub async fn query_or_form<F>(&mut self, key: &str) -> Option<F> where
F: FromStr,

pub async fn read_from_text<T>(&mut self) -> Result<T, ParseError> where
T: FromStr,

pub async fn read_from_json<T>(&mut self) -> Result<T, ParseError> where
T: DeserializeOwned,

pub async fn read_from_form<T>(&mut self) -> Result<T, ParseError> where
T: DeserializeOwned,

pub async fn read<T>(&mut self) -> Result<T, ParseError> where
T: DeserializeOwned,

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

impl<'a, T> AsTaggedExplicit<'a> for T where
T: 'a,

impl<'a, T> AsTaggedImplicit<'a> for T where
T: 'a,

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

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

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

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

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

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

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

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