Struct actix_web::web::Json [−][src]
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 process.
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(), }) }
Implementations
impl<T> Json<T>
[src]
pub fn into_inner(self) -> T
[src]
Unwrap into inner T
value.
Trait Implementations
impl<T> Debug for Json<T> where
T: Debug,
[src]
T: Debug,
impl<T> Deref for Json<T>
[src]
impl<T> DerefMut for Json<T>
[src]
impl<T> Display for Json<T> where
T: Display,
[src]
T: Display,
impl<T> FromRequest for Json<T> where
T: DeserializeOwned + 'static,
[src]
T: DeserializeOwned + 'static,
See here for example of usage as an extractor.
type Error = Error
The associated error which can be returned.
type Future = JsonExtractFut<T>
Future that resolves to a Self.
type Config = JsonConfig
Configuration for this extractor.
fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future
[src]
fn extract(req: &HttpRequest) -> Self::Future
[src]
fn configure<F>(f: F) -> Self::Config where
F: FnOnce(Self::Config) -> Self::Config,
[src]
F: FnOnce(Self::Config) -> Self::Config,
impl<T: Serialize> Responder for Json<T>
[src]
Creates response with OK status code, correct content type header, and serialized JSON payload.
If serialization failed
fn respond_to(self, _: &HttpRequest) -> HttpResponseⓘ
[src]
fn with_status(self, status: StatusCode) -> CustomResponder<Self> where
Self: Sized,
[src]
Self: Sized,
fn with_header<H>(self, header: H) -> CustomResponder<Self> where
Self: Sized,
H: IntoHeaderPair,
[src]
Self: Sized,
H: IntoHeaderPair,
Auto Trait Implementations
impl<T> RefUnwindSafe for Json<T> where
T: RefUnwindSafe,
[src]
T: RefUnwindSafe,
impl<T> Send for Json<T> where
T: Send,
[src]
T: Send,
impl<T> Sync for Json<T> where
T: Sync,
[src]
T: Sync,
impl<T> Unpin for Json<T> where
T: Unpin,
[src]
T: Unpin,
impl<T> UnwindSafe for Json<T> where
T: UnwindSafe,
[src]
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,