Struct actix_web_validator::Json
source · [−]pub struct Json<T>(pub T);
Expand description
Json can be used for exstracting typed information and validation from request’s payload.
To extract and typed information from request’s body, the type T
must
implement the Deserialize
trait from serde
and Validate
trait from validator crate.
JsonConfig allows to configure extraction process.
Example
use actix_web::{web, App};
use actix_web_validator::Json;
use serde::Deserialize;
use validator::Validate;
#[derive(Deserialize, Validate)]
struct Info {
#[validate(length(min = 3))]
username: String,
}
/// deserialize `Info` from request's body
async fn index(info: Json<Info>) -> String {
format!("Welcome {}!", info.username)
}
fn main() {
let app = App::new().service(
web::resource("/index.html").route(
web::post().to(index))
);
}
Tuple Fields
0: T
Implementations
sourceimpl<T> Json<T>
impl<T> Json<T>
sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Deconstruct to an inner value
Trait Implementations
sourceimpl<T> FromRequest for Json<T> where
T: DeserializeOwned + Validate + 'static,
impl<T> FromRequest for Json<T> where
T: DeserializeOwned + Validate + 'static,
Json extractor. Allow to extract typed information from request’s payload and validate it.
To extract typed information from request’s body, the type T
must
implement the Deserialize
trait from serde.
To validate payload, the type T
must implement the Validate
trait
from validator crate.
JsonConfig allows to configure extraction process.
Example
use actix_web::{web, App};
use actix_web_validator::Json;
use serde::Deserialize;
use validator::Validate;
#[derive(Deserialize, Validate)]
struct Info {
#[validate(length(min = 3))]
username: String,
}
/// deserialize `Info` from request's body
async fn index(info: Json<Info>) -> String {
format!("Welcome {}!", info.username)
}
fn main() {
let app = App::new().service(
web::resource("/index.html").route(
web::post().to(index))
);
}
type Future = Pin<Box<dyn Future<Output = Result<Json<T>, <Json<T> as FromRequest>::Error>> + 'static, Global>>
type Future = Pin<Box<dyn Future<Output = Result<Json<T>, <Json<T> as FromRequest>::Error>> + 'static, Global>>
Future that resolves to a Self
. Read more
sourcefn 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.
sourcefn extract(req: &HttpRequest) -> Self::Future
fn extract(req: &HttpRequest) -> Self::Future
Create a Self
from request head asynchronously. Read more
Auto Trait Implementations
impl<T> RefUnwindSafe for Json<T> where
T: RefUnwindSafe,
impl<T> Send for Json<T> where
T: Send,
impl<T> Sync for Json<T> where
T: Sync,
impl<T> Unpin for Json<T> where
T: Unpin,
impl<T> UnwindSafe for Json<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more