Skip to main content

Json

Struct Json 

Source
pub struct Json<T>(pub T);
Expand description

A JSON extractor and responder.

Json<T> wraps any value T and grants it two complementary roles inside a Churust handler:

§As an extractor (handler argument)

When placed as the last handler argument, Json<T> reads the entire request body and attempts to deserialize it as JSON into T. T must implement serde::de::DeserializeOwned.

The request must declare a JSON content type — application/json, or any +json structured suffix. Anything else is 415 Unsupported Media Type, which is what keeps a cross-origin HTML form (whose three possible content types send no CORS preflight) from reaching a JSON handler with the visitor’s cookies attached.

If the body is missing or malformed the framework returns an HTTP 400 Bad Request response automatically — the handler is never called.

use churust_core::{Churust, TestClient};
use churust_json::Json;
use serde::Deserialize;

#[derive(Deserialize)]
struct CreateUser { username: String }

let app = Churust::server()
    .routing(|r| {
        r.post("/users", |Json(body): Json<CreateUser>| async move {
            format!("created {}", body.username)
        });
    })
    .build();

let res = TestClient::new(app)
    .post("/users")
    .header("content-type", "application/json")
    .body(r#"{"username":"bob"}"#)
    .send()
    .await;
assert_eq!(res.status().as_u16(), 200);

§As a responder (return value)

Wrapping any T: Serialize in Json and returning it from a handler serializes T to JSON and sets the Content-Type header to application/json.

If serialization fails at runtime (extremely rare for well-formed types) the framework returns an HTTP 500 Internal Server Error.

use churust_core::{Churust, Call, TestClient};
use churust_json::Json;
use serde::Serialize;

#[derive(Serialize)]
struct Status { ok: bool }

let app = Churust::server()
    .routing(|r| {
        r.get("/status", |_c: Call| async { Json(Status { ok: true }) });
    })
    .build();

let res = TestClient::new(app).get("/status").send().await;
assert_eq!(res.status().as_u16(), 200);
assert_eq!(res.header("content-type"), Some("application/json"));

§Pattern destructuring

The inner value is accessed through .0 or via pattern destructuring:

use churust_json::Json;
use serde::Deserialize;

#[derive(Deserialize, Debug, PartialEq)]
struct Point { x: f64, y: f64 }

// Pattern destructuring extracts the inner value directly.
let Json(point) = Json(Point { x: 1.0, y: 2.0 });
assert_eq!(point, Point { x: 1.0, y: 2.0 });

Tuple Fields§

§0: T

The inner value being wrapped.

Access it with .0 or destructure: let Json(value) = json_wrapper;.

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> FromCall for Json<T>

Source§

fn from_call<'async_trait>( call: Call, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>
where Self: 'async_trait,

Build Self by consuming the call, or return an Error (which the handler renders as the response).
Source§

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

Source§

fn into_response(self) -> Response

Consume self and produce the Response to send.

Auto Trait Implementations§

§

impl<T> Freeze for Json<T>
where T: Freeze,

§

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> UnsafeUnpin for Json<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Json<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more