Struct actix_web::web::Json [−][src]
pub struct Json<T>(pub T);
Expand description
JSON extractor and responder.
Json
has two uses: JSON responses, and extracting typed data from JSON request payloads.
Extractor
To extract typed data from a request body, the inner type T
must implement the
serde::Deserialize
trait.
Use JsonConfig
to configure extraction options.
use actix_web::{post, web, App};
use serde::Deserialize;
#[derive(Deserialize)]
struct Info {
username: String,
}
/// deserialize `Info` from request's body
#[post("/")]
async fn index(info: web::Json<Info>) -> String {
format!("Welcome {}!", info.username)
}
Responder
The Json
type JSON formatted responses. A handler may return a value of type
Json<T>
where T
is the type of a structure to serialize into JSON. The type T
must
implement serde::Serialize
.
use actix_web::{post, web, HttpRequest};
use serde::Serialize;
#[derive(Serialize)]
struct Info {
name: String,
}
#[post("/{name}")]
async fn index(req: HttpRequest) -> web::Json<Info> {
web::Json(Info {
name: req.match_info().get("name").unwrap().to_owned(),
})
}
Tuple Fields
0: T
Implementations
Unwrap into inner T
value.
Trait Implementations
See here for example of usage as an extractor.
Creates response with OK status code, correct content type header, and serialized JSON payload.
If serialization failed
fn respond_to(self, _: &HttpRequest) -> HttpResponseⓘNotable traits for HttpResponse<Body>impl Future for HttpResponse<Body> type Output = Result<Response<Body>, Error>;
fn respond_to(self, _: &HttpRequest) -> HttpResponseⓘNotable traits for HttpResponse<Body>impl Future for HttpResponse<Body> type Output = Result<Response<Body>, Error>;
impl Future for HttpResponse<Body> type Output = Result<Response<Body>, Error>;
Convert self to HttpResponse
.
Override a status code for a Responder. Read more
fn with_header<H>(self, header: H) -> CustomResponder<Self> where
Self: Sized,
H: IntoHeaderPair,
fn with_header<H>(self, header: H) -> CustomResponder<Self> where
Self: Sized,
H: IntoHeaderPair,
Insert header to the final response. Read more
Auto Trait Implementations
impl<T> RefUnwindSafe for Json<T> where
T: RefUnwindSafe,
impl<T> UnwindSafe for Json<T> where
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more