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
sourceimpl<T> Json<T>
impl<T> Json<T>
sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Unwrap into inner T
value.
Trait Implementations
sourceimpl<T> FromRequest for Json<T> where
T: DeserializeOwned,
impl<T> FromRequest for Json<T> where
T: DeserializeOwned,
See here for example of usage as an extractor.
type Future = JsonExtractFut<T>
type Future = JsonExtractFut<T>
Future that resolves to a Self.
sourcefn from_request(
req: &HttpRequest,
payload: &mut Payload<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>
) -> <Json<T> as FromRequest>::Future
fn from_request(
req: &HttpRequest,
payload: &mut Payload<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>
) -> <Json<T> as FromRequest>::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
sourceimpl<T> Responder for Json<T> where
T: Serialize,
impl<T> Responder for Json<T> where
T: Serialize,
Creates response with OK status code, correct content type header, and serialized JSON payload.
If serialization failed
type Body = EitherBody<String, BoxBody>
sourcefn respond_to(self, &HttpRequest) -> HttpResponse<<Json<T> as Responder>::Body>
fn respond_to(self, &HttpRequest) -> HttpResponse<<Json<T> as Responder>::Body>
Convert self to HttpResponse
.
sourcefn customize(self) -> CustomizeResponder<Self>
fn customize(self) -> CustomizeResponder<Self>
Wraps responder to allow alteration of its response. Read more
sourceimpl<T> Serialize for Json<T> where
T: Serialize,
impl<T> Serialize for Json<T> where
T: Serialize,
sourcefn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. 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<T, P> Resource for T where
T: DerefMut<Target = Path<P>>,
P: ResourcePath,
impl<T, P> Resource for T where
T: DerefMut<Target = Path<P>>,
P: ResourcePath,
type Path = P
type Path = P
Type of resource’s path returned in resource_path
.
fn resource_path(&mut self) -> &mut Path<<T as Resource>::Path>
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