Struct Json 

pub struct Json<T>(pub T);

JSON request body extractor and response, whose failures are JSON too.

As an extractor it requires Content-Type: application/json; unlike axum::Json, a body that is missing that header or is not valid JSON for T is answered with a JSON 400 (ApiError with Error::BadRequest carrying axum’s explanation). As a response it serializes T with status 200 and Content-Type: application/json.

Examples

use axum::{http::StatusCode, response::IntoResponse};
use ocre::Json;

let response = Json(serde_json::json!({"id": 1})).into_response();
assert_eq!(response.status(), StatusCode::OK);
assert_eq!(response.headers()["content-type"], "application/json");

In a handler:

use ocre::{ApiResult, Json};
use serde::{Deserialize, Serialize};

#[derive(Deserialize, Serialize)]
struct Echo {
    message: String,
}

async fn echo(Json(body): Json<Echo>) -> ApiResult<Json<Echo>> {
    Ok(Json(body))
}

Tuple Fields

0: T

Trait Implementations

impl<T: Clone> Clone for Json<T>

fn clone(&self) -> Json<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy> Copy for Json<T>

impl<T: Debug> Debug for Json<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Json<T>

fn default() -> Json<T>

Returns the “default value” for a type.

impl<T: DeserializeOwned, S: Send + Sync> FromRequest<S> for Json<T>

type Rejection = ApiError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request(req: Request, state: &S) -> Result<Self, Self::Rejection>

Perform the extraction.

impl<T: Serialize> IntoResponse for Json<T>

fn into_response(self) -> Response

Create a response.