Trait actix_web::FromRequest

pub trait FromRequest<S>: Sized where
    S: 'static, {
    type Config: Default;
    type Result: Future<Item = Self, Error = Error>;
    fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> 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: Future<Item = Self, Error = Error>

Future that resolves to a Self

Required Methods

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

Convert request to a Self

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 = Either<FutureResult<Self, Error>, Box<Future<Item = Self, Error = Error>>>

fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> 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(index)   // <- register handler with extractor params
               .limit(4096);  // <- limit size of the payload
       });
}

type Config = PayloadConfig

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

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

Implementors

• impl<T, S> FromRequest<S> for Path<T> where
    T: DeserializeOwned,
    S: 'static,  type Config = (); type Result = FutureResult<Self, Error>;
• impl<T, S> FromRequest<S> for Query<T> where
    T: DeserializeOwned,
    S: 'static,  type Config = (); type Result = FutureResult<Self, Error>;
• impl<T, S> FromRequest<S> for Form<T> where
    T: DeserializeOwned + 'static,
    S: 'static,  type Config = FormConfig; type Result = Box<Future<Item = Self, Error = Error>>;
• impl<S: 'static> FromRequest<S> for State<S> type Config = (); type Result = FutureResult<Self, Error>;
• impl<S: 'static> FromRequest<S> for HttpRequest<S> type Config = (); type Result = FutureResult<Self, Error>;
• 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>>;