Struct ntex::web::types::Json

pub struct Json<T>(pub T);

Json helper

Json can be used for two different purpose. First is for json response generation and second is for extracting typed information from request’s payload.

To extract typed information from request’s body, the type T must implement the Deserialize trait from serde.

JsonConfig allows to configure extraction process.

Example

use ntex::web;

#[derive(serde::Deserialize)]
struct Info {
    username: String,
}

/// deserialize `Info` from request's body
async fn index(info: web::types::Json<Info>) -> String {
    format!("Welcome {}!", info.username)
}

fn main() {
    let app = web::App::new().service(
       web::resource("/index.html").route(
           web::post().to(index))
    );
}

The Json type allows you to respond with well-formed JSON data: simply return a value of type Json where T is the type of a structure to serialize into JSON. The type T must implement the Serialize trait from serde.

use ntex::web;

#[derive(serde::Serialize)]
struct MyObj {
    name: String,
}

fn index(req: web::HttpRequest) -> Result<web::types::Json<MyObj>, std::io::Error> {
    Ok(web::types::Json(MyObj {
        name: req.match_info().get("name").unwrap().to_string(),
    }))
}

Tuple Fields

0: T

Implementations

impl<T> Json<T>

pub fn into_inner(self) -> T

Deconstruct to an inner value

Trait Implementations

impl<T> Debug for Json<T>

where T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Deref for Json<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Json<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T> Display for Json<T>

where T: Display,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, Err: ErrorRenderer> FromRequest<Err> for Json<T>

where T: DeserializeOwned + 'static,

Json extractor. Allow to extract typed information from request’s payload.

To extract typed information from request’s body, the type T must implement the Deserialize trait from serde.

JsonConfig allows to configure extraction process.

Example

use ntex::web;

#[derive(serde::Deserialize)]
struct Info {
    username: String,
}

/// deserialize `Info` from request's body
async fn index(info: web::types::Json<Info>) -> String {
    format!("Welcome {}!", info.username)
}

fn main() {
    let app = web::App::new().service(
        web::resource("/index.html").route(
           web::post().to(index))
    );
}

type Error = JsonPayloadError

The associated error which can be returned.

async fn from_request( req: &HttpRequest, payload: &mut Payload ) -> Result<Self, Self::Error>

Convert request to a Self

impl<T: Serialize, Err: ErrorRenderer> Responder<Err> for Json<T>

where Err::Container: From<JsonError>,

async fn respond_to(self, req: &HttpRequest) -> Response

Convert itself to http response.

fn with_status(self, status: StatusCode) -> CustomResponder<Self, Err>

where Self: Sized,

Override a status code for a Responder.

fn with_header<K, V>(self, key: K, value: V) -> CustomResponder<Self, Err>

where Self: Sized, HeaderName: TryFrom<K>, HeaderValue: TryFrom<V>, <HeaderName as TryFrom<K>>::Error: Into<HttpError>, <HeaderValue as TryFrom<V>>::Error: Into<HttpError>,

Add header to the Responder’s response.