Trait viz_core::RequestExt

pub trait RequestExt: Sized {
    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 content_length(&self) -> Option<u64>;
    fn content_type(&self) -> Option<Mime>;
    fn extract<'life0, 'async_trait, T>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<T, T::Error>> + Send + 'async_trait>>
    where
        T: FromRequest + 'async_trait,
        Self: 'async_trait,
        'life0: 'async_trait;
    fn bytes<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<Bytes, PayloadError>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait;
    fn bytes_with<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        name: &'life1 str,
        max: u64
    ) -> Pin<Box<dyn Future<Output = Result<Bytes, PayloadError>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
        'life1: 'async_trait;
    fn text<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<String, PayloadError>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait;
    fn form<'life0, 'async_trait, T>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<T, PayloadError>> + Send + 'async_trait>>
    where
        T: DeserializeOwned + 'async_trait,
        Self: 'async_trait,
        'life0: 'async_trait;
    fn json<'life0, 'async_trait, T>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<T, PayloadError>> + Send + 'async_trait>>
    where
        T: DeserializeOwned + 'async_trait,
        Self: 'async_trait,
        'life0: 'async_trait;
    fn multipart<'life0, 'async_trait>(
        &'life0 mut self
    ) -> Pin<Box<dyn Future<Output = Result<Multipart, PayloadError>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait;
    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 limits(&self) -> &Limits;
    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>;
}

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.

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

Get a header with the specified type by the key.

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<'life0, 'async_trait, T>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<T, T::Error>> + Send + 'async_trait>>where
    T: FromRequest + 'async_trait,
    Self: 'async_trait,
    'life0: 'async_trait,

Extract the data from this request by the specified type.

fn bytes<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Bytes, PayloadError>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Return with a Bytes representation of the request body.

fn bytes_with<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    name: &'life1 str,
    max: u64
) -> Pin<Box<dyn Future<Output = Result<Bytes, PayloadError>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,

Available on crate feature limits only.

Return with a Bytes by a limit representation of the request body.

fn text<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<String, PayloadError>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Return with a Text representation of the request body.

fn form<'life0, 'async_trait, T>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<T, PayloadError>> + Send + 'async_trait>>where
    T: DeserializeOwned + 'async_trait,
    Self: 'async_trait,
    'life0: 'async_trait,

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<'life0, 'async_trait, T>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<T, PayloadError>> + Send + 'async_trait>>where
    T: DeserializeOwned + 'async_trait,
    Self: 'async_trait,
    'life0: 'async_trait,

Available on crate feature json only.

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

fn multipart<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Multipart, PayloadError>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

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.

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 limits(&self) -> &Limits

Available on crate feature limits only.

Get limits settings.

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.

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.

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

Get current route.

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

Get remote addr.

Implementors

impl RequestExt for Request<Body>