Trait viz_core::RequestExt

pub trait RequestExt: Sealed + Sized {
    // Required methods
    fn schema(&self) -> Option<&Scheme>;
    fn path(&self) -> &str;
    fn query_string(&self) -> Option<&str>;
    fn query<T>(&self) -> Result<T, PayloadError>
       where T: DeserializeOwned;
    fn header<K, T>(&self, key: K) -> Option<T>
       where K: AsHeaderName,
             T: FromStr;
    fn header_typed<H>(&self) -> Option<H>
       where H: Header;
    fn content_length(&self) -> Option<u64>;
    fn content_type(&self) -> Option<Mime>;
    fn extract<T>(&mut self) -> impl Future<Output = Result<T, T::Error>> + Send
       where T: FromRequest;
    fn incoming(&mut self) -> Result<Body, PayloadError>;
    fn bytes(
        &mut self,
    ) -> impl Future<Output = Result<Bytes, PayloadError>> + Send;
    fn text(
        &mut self,
    ) -> impl Future<Output = Result<String, PayloadError>> + Send;
    fn form<T>(
        &mut self,
    ) -> impl Future<Output = Result<T, PayloadError>> + Send
       where T: DeserializeOwned;
    fn json<T>(
        &mut self,
    ) -> impl Future<Output = Result<T, PayloadError>> + Send
       where T: DeserializeOwned;
    fn multipart(
        &mut self,
    ) -> impl Future<Output = Result<Multipart, PayloadError>> + Send;
    fn state<T>(&self) -> Option<T>
       where T: Clone + Send + Sync + 'static;
    fn set_state<T>(&mut self, t: T) -> Option<T>
       where T: Clone + Send + Sync + 'static;
    fn cookies(&self) -> Result<Cookies, CookiesError>;
    fn cookie<S>(&self, name: S) -> Option<Cookie<'_>>
       where S: AsRef<str>;
    fn session(&self) -> &Session;
    fn params<T>(&self) -> Result<T, ParamsError>
       where T: DeserializeOwned;
    fn param<T>(&self, name: &str) -> Result<T, ParamsError>
       where T: FromStr,
             T::Err: Display;
    fn route_info(&self) -> &Arc<RouteInfo>;
    fn remote_addr(&self) -> Option<&SocketAddr>;
    fn realip(&self) -> Option<RealIp>;
}

The Request Extension.

Required Methods

fn schema(&self) -> Option<&Scheme>

Get URL’s schema of this request.

fn path(&self) -> &str

Get URL’s path of this request.

fn query_string(&self) -> Option<&str>

Get URL’s query string of this request.

fn query<T>(&self) -> Result<T, PayloadError>

where T: DeserializeOwned,

Available on crate feature query only.

Get query data by type.

Errors

Will return PayloadError::UrlDecode if decoding the query string fails.

fn header<K, T>(&self, key: K) -> Option<T>

where K: AsHeaderName, T: FromStr,

Get a header with the key.

fn header_typed<H>(&self) -> Option<H>

where H: Header,

Get a header with the specified type.

fn content_length(&self) -> Option<u64>

Get the size of this request’s body.

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

Get the media type of this request.

fn extract<T>(&mut self) -> impl Future<Output = Result<T, T::Error>> + Send

where T: FromRequest,

Extract the data from this request by the specified type.

fn incoming(&mut self) -> Result<Body, PayloadError>

Get an incoming body.

Errors

Will return PayloadError::Empty or PayloadError::Used if the incoming does not exist or be used.

fn bytes(&mut self) -> impl Future<Output = Result<Bytes, PayloadError>> + Send

Return with a Bytes representation of the request body.

fn text(&mut self) -> impl Future<Output = Result<String, PayloadError>> + Send

Return with a Text representation of the request body.

fn form<T>(&mut self) -> impl Future<Output = Result<T, PayloadError>> + Send

where T: DeserializeOwned,

Available on crate feature form only.

Return with a application/x-www-form-urlencoded FormData by the specified type representation of the request body.

fn json<T>(&mut self) -> impl Future<Output = Result<T, PayloadError>> + Send

where T: DeserializeOwned,

Available on crate feature json only.

Return with a JSON by the specified type representation of the request body.

fn multipart( &mut self, ) -> impl Future<Output = Result<Multipart, PayloadError>> + Send

Available on crate feature multipart only.

Return with a multipart/form-data FormData by the specified type representation of the request body.

fn state<T>(&self) -> Option<T>

where T: Clone + Send + Sync + 'static,

Available on crate feature state only.

Return a shared state by the specified type.

fn set_state<T>(&mut self, t: T) -> Option<T>

where T: Clone + Send + Sync + 'static,

Available on crate feature state only.

Store a shared state.

fn cookies(&self) -> Result<Cookies, CookiesError>

Available on crate feature cookie only.

Get a wrapper of cookie-jar for managing cookies.

Errors

Will return CookiesError if getting cookies fails.

fn cookie<S>(&self, name: S) -> Option<Cookie<'_>>

where S: AsRef<str>,

Available on crate feature cookie only.

Get a cookie by the specified name.

fn session(&self) -> &Session

Available on crate feature session only.

Get current session.

fn params<T>(&self) -> Result<T, ParamsError>

where T: DeserializeOwned,

Available on crate feature params only.

Get all parameters.

Errors

Will return ParamsError if deserializer the parameters fails.

fn param<T>(&self, name: &str) -> Result<T, ParamsError>

where T: FromStr, T::Err: Display,

Available on crate feature params only.

Get single parameter by name.

Errors

Will return ParamsError if deserializer the single parameter fails.

fn route_info(&self) -> &Arc<RouteInfo>

Available on crate feature params only.

Get current route.

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

Get remote addr.

fn realip(&self) -> Option<RealIp>

Get realip.

Object Safety

This trait is not object safe.

Implementors

impl RequestExt for Request