Trait actix_web::FromRequest

pub trait FromRequest<S>: Sized {
    type Config: Default;
    type Result: Into<AsyncResult<Self>>;
    fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result;

    fn extract(req: &HttpRequest<S>) -> Self::Result { ... }
}

Trait implemented by types that can be extracted from request.

Types that implement this trait can be used with Route::with() method.

Associated Types

type Config: Default

Configuration for conversion process

type Result: Into<AsyncResult<Self>>

Future that resolves to a Self

Required Methods

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

Convert request to a Self

Provided Methods

fn extract(req: &HttpRequest<S>) -> Self::Result

Convert request to a Self

This method uses default extractor configuration

Implementations on Foreign Types

impl<S: 'static> FromRequest<S> for Bytes

Request payload extractor.

Loads request's payload and construct Bytes instance.

PayloadConfig allows to configure extraction process.

Example

extern crate bytes;
use actix_web::{http, App, Result};

/// extract text data from request
fn index(body: bytes::Bytes) -> Result<String> {
    Ok(format!("Body {:?}!", body))
}

fn main() {
    let app = App::new()
        .resource("/index.html", |r| r.method(http::Method::GET).with(index));
}

type Config = PayloadConfig

type Result = Result<Box<Future<Item = Self, Error = Error>>, Error>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

impl<S: 'static> FromRequest<S> for String

Extract text information from the request's body.

Text extractor automatically decode body according to the request's charset.

PayloadConfig allows to configure extraction process.

Example

use actix_web::{http, App, Result};

/// extract text data from request
fn index(body: String) -> Result<String> {
    Ok(format!("Body {}!", body))
}

fn main() {
    let app = App::new().resource("/index.html", |r| {
        r.method(http::Method::GET)
               .with_config(index, |cfg| { // <- register handler with extractor params
                  cfg.limit(4096);  // <- limit size of the payload
                })
    });
}

type Config = PayloadConfig

type Result = Result<Box<Future<Item = String, Error = Error>>, Error>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

impl<S, A: FromRequest<S> + 'static> FromRequest<S> for (A,) where     S: 'static,

FromRequest implementation for tuple

type Config = (A::Config,)

type Result = Box<Future<Item = (A,), Error = Error>>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

impl<S, A: FromRequest<S> + 'static, B: FromRequest<S> + 'static> FromRequest<S> for (A, B) where     S: 'static,

FromRequest implementation for tuple

type Config = (A::Config, B::Config)

type Result = Box<Future<Item = (A, B), Error = Error>>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

impl<S, A: FromRequest<S> + 'static, B: FromRequest<S> + 'static, C: FromRequest<S> + 'static> FromRequest<S> for (A, B, C) where     S: 'static,

FromRequest implementation for tuple

type Config = (A::Config, B::Config, C::Config)

type Result = Box<Future<Item = (A, B, C), Error = Error>>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

impl<S, A: FromRequest<S> + 'static, B: FromRequest<S> + 'static, C: FromRequest<S> + 'static, D: FromRequest<S> + 'static> FromRequest<S> for (A, B, C, D) where     S: 'static,

FromRequest implementation for tuple

type Config = (A::Config, B::Config, C::Config, D::Config)

type Result = Box<Future<Item = (A, B, C, D), Error = Error>>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

impl<S, A: FromRequest<S> + 'static, B: FromRequest<S> + 'static, C: FromRequest<S> + 'static, D: FromRequest<S> + 'static, E: FromRequest<S> + 'static> FromRequest<S> for (A, B, C, D, E) where     S: 'static,

FromRequest implementation for tuple

type Config = (A::Config, B::Config, C::Config, D::Config, E::Config)

type Result = Box<Future<Item = (A, B, C, D, E), Error = Error>>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

impl<S, A: FromRequest<S> + 'static, B: FromRequest<S> + 'static, C: FromRequest<S> + 'static, D: FromRequest<S> + 'static, E: FromRequest<S> + 'static, F: FromRequest<S> + 'static> FromRequest<S> for (A, B, C, D, E, F) where     S: 'static,

FromRequest implementation for tuple

type Config = (A::Config, B::Config, C::Config, D::Config, E::Config, F::Config)

type Result = Box<Future<Item = (A, B, C, D, E, F), Error = Error>>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

impl<S, A: FromRequest<S> + 'static, B: FromRequest<S> + 'static, C: FromRequest<S> + 'static, D: FromRequest<S> + 'static, E: FromRequest<S> + 'static, F: FromRequest<S> + 'static, G: FromRequest<S> + 'static> FromRequest<S> for (A, B, C, D, E, F, G) where     S: 'static,

FromRequest implementation for tuple

type Config = (A::Config, B::Config, C::Config, D::Config, E::Config, F::Config, G::Config)

type Result = Box<Future<Item = (A, B, C, D, E, F, G), Error = Error>>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

impl<S, A: FromRequest<S> + 'static, B: FromRequest<S> + 'static, C: FromRequest<S> + 'static, D: FromRequest<S> + 'static, E: FromRequest<S> + 'static, F: FromRequest<S> + 'static, G: FromRequest<S> + 'static, H: FromRequest<S> + 'static> FromRequest<S> for (A, B, C, D, E, F, G, H) where     S: 'static,

FromRequest implementation for tuple

type Config = (A::Config, B::Config, C::Config, D::Config, E::Config, F::Config, G::Config, H::Config)

type Result = Box<Future<Item = (A, B, C, D, E, F, G, H), Error = Error>>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

impl<S, A: FromRequest<S> + 'static, B: FromRequest<S> + 'static, C: FromRequest<S> + 'static, D: FromRequest<S> + 'static, E: FromRequest<S> + 'static, F: FromRequest<S> + 'static, G: FromRequest<S> + 'static, H: FromRequest<S> + 'static, I: FromRequest<S> + 'static> FromRequest<S> for (A, B, C, D, E, F, G, H, I) where     S: 'static,

FromRequest implementation for tuple

type Config = (A::Config, B::Config, C::Config, D::Config, E::Config, F::Config, G::Config, H::Config, I::Config)

type Result = Box<Future<Item = (A, B, C, D, E, F, G, H, I), Error = Error>>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result

fn extract(req: &HttpRequest<S>) -> Self::Result

Implementors

• impl<T, S> FromRequest<S> for Path<T> where     T: DeserializeOwned,  type Config = (); type Result = Result<Self, Error>;

• impl<T, S> FromRequest<S> for Query<T> where     T: DeserializeOwned,  type Config = (); type Result = Result<Self, Error>;

• impl<T, S> FromRequest<S> for Form<T> where     T: DeserializeOwned + 'static,     S: 'static,  type Config = FormConfig<S>; type Result = Box<Future<Item = Self, Error = Error>>;

• impl<S> FromRequest<S> for State<S> type Config = (); type Result = State<S>;

• impl<S> FromRequest<S> for HttpRequest<S> type Config = (); type Result = Self;

• impl<T, S> FromRequest<S> for Json<T> where     T: DeserializeOwned + 'static,     S: 'static,  type Config = JsonConfig<S>; type Result = Box<Future<Item = Self, Error = Error>>;

• impl<S> FromRequest<S> for Session type Config = (); type Result = Session;