Trait actix_web::FromRequest [−][src]
pub trait FromRequest: Sized { type Config: Default + 'static; type Error: Into<Error>; type Future: Future<Output = Result<Self, Self::Error>>; fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future; fn extract(req: &HttpRequest) -> Self::Future { ... } fn configure<F>(f: F) -> Self::Config
where
F: FnOnce(Self::Config) -> Self::Config, { ... } }
Expand description
Trait implemented by types that can be extracted from request.
Types that implement this trait can be used with Route
handlers.
Associated Types
Required methods
fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future
fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future
Create a Self from request parts asynchronously.
Provided methods
fn extract(req: &HttpRequest) -> Self::Future
fn extract(req: &HttpRequest) -> Self::Future
Create a Self from request head asynchronously.
This method is short for T::from_request(req, &mut Payload::None)
.
Implementations on Foreign Types
Optionally extract a field from the request
If the FromRequest for T fails, return None rather than returning an error response
Examples
use actix_web::{web, dev, App, Error, HttpRequest, FromRequest}; use actix_web::error::ErrorBadRequest; use futures_util::future::{ok, err, Ready}; use serde_derive::Deserialize; use rand; #[derive(Debug, Deserialize)] struct Thing { name: String } impl FromRequest for Thing { type Error = Error; type Future = Ready<Result<Self, Self::Error>>; type Config = (); fn from_request(req: &HttpRequest, payload: &mut dev::Payload) -> Self::Future { if rand::random() { ok(Thing { name: "thingy".into() }) } else { err(ErrorBadRequest("no luck")) } } } /// extract `Thing` from request async fn index(supplied_thing: Option<Thing>) -> String { match supplied_thing { // Puns not intended Some(thing) => format!("Got something: {:?}", thing), None => format!("No thing!") } } fn main() { let app = App::new().service( web::resource("/users/:first").route( web::post().to(index)) ); }
impl<T> FromRequest for Result<T, T::Error> where
T: FromRequest + 'static,
T::Error: 'static,
T::Future: 'static,
impl<T> FromRequest for Result<T, T::Error> where
T: FromRequest + 'static,
T::Error: 'static,
T::Future: 'static,
Optionally extract a field from the request or extract the Error if unsuccessful
If the FromRequest
for T fails, inject Err into handler rather than returning an error response
Examples
use actix_web::{web, dev, App, Result, Error, HttpRequest, FromRequest}; use actix_web::error::ErrorBadRequest; use futures_util::future::{ok, err, Ready}; use serde_derive::Deserialize; use rand; #[derive(Debug, Deserialize)] struct Thing { name: String } impl FromRequest for Thing { type Error = Error; type Future = Ready<Result<Thing, Error>>; type Config = (); fn from_request(req: &HttpRequest, payload: &mut dev::Payload) -> Self::Future { if rand::random() { ok(Thing { name: "thingy".into() }) } else { err(ErrorBadRequest("no luck")) } } } /// extract `Thing` from request async fn index(supplied_thing: Result<Thing>) -> String { match supplied_thing { Ok(thing) => format!("Got thing: {:?}", thing), Err(e) => format!("Error extracting thing: {}", e) } } fn main() { let app = App::new().service( web::resource("/users/:first").route(web::post().to(index)) ); }
Extract text information from a request’s body.
Text extractor automatically decode body according to the request’s charset.
PayloadConfig allows to configure extraction process.
Examples
use actix_web::{post, web, FromRequest}; // extract text data from request #[post("/")] async fn index(text: String) -> String { format!("Body {}!", text) }
type Config = PayloadConfig
Implementors
impl<L, R> FromRequest for Either<L, R> where
L: FromRequest + 'static,
R: FromRequest + 'static,