Struct salvo::prelude::Request

impl Request

pub fn new() -> Request

Creates a new blank Request

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.

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

Returns a mutable reference to the associated version.

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

Get request remote address.

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

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.

pub fn add_header<N, V>(
 &mut self,
 name: N,
 value: V,
 overwrite: bool
) -> Result<(), Error>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.

pub fn with_header<N, V>(
 &mut self,
 name: N,
 value: V,
 overwrite: bool
) -> Result<&mut Request, Error>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.

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

Returns a reference to the associated HTTP body.

Examples

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

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

Returns a mutable reference to the associated HTTP body.

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

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

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

Examples

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

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

pub fn accept(&self) -> Vec<Mime, Global> ⓘ

Get accept.

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

Get first accept.

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

Get content type.

pub fn cookies(&self) -> &CookieJar

Get CookieJar reference.

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

Get CookieJar mutable reference.

Get Cookie from cookies.

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

Get params reference.

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

Get params mutable reference.

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

Get param value from params.

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

Get queries reference.

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

Get query value from queries.

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

Get field data from form.

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

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

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

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

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

Get FilePart reference from request.

pub async fn first_file(&mut self) -> impl Future<Output = Option<&FilePart>>

Get FilePart reference from request.

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

Get FilePart list reference from request.

pub async fn all_files(
&mut self
) -> impl Future<Output = Vec<&FilePart, Global>>

Get FilePart list reference from request.

pub async fn payload(
&mut self
) -> impl Future<Output = Result<&Vec<u8, Global>, ParseError>>

Get request payload.

*Notice: This method takes body.

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

Get FormData reference from request.

*Notice: This method takes body.

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

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

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

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

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

Parse url params as type T from request.

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

Parse queries as type T from request.

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

Parse headers as type T from request.

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

Parse cookies as type T from request.

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

Parse json body as type T from request.

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

Parse form body as type T from request.

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

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

Trait Implementations§

impl Debug for Request

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

Formats the value using the given formatter. Read more

impl Default for Request

fn default() -> Request

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

impl From<Request<Body>> for Request

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

Converts to this type from the input type.

Auto Trait Implementations§

impl !UnwindSafe for Request

Blanket Implementations§

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

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>

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

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.

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

impl<T> WithSubscriber for T

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