Skip to main content

Json

Struct Json 

Source
pub struct Json<T>(pub T);
Available on crate feature serde only.
Expand description

A JSON extractor and responder backed by serde_json.

Wrap a Deserialize type to extract JSON from a request body, or wrap a Serialize type to produce a 200 OK application/json response.

§Deserializing (request → typed struct)

use serde::Deserialize;
use rust_web_server::json::Json;
use rust_web_server::request::Request;

#[derive(Deserialize)]
struct CreateUser { name: String, age: u32 }

fn handler(req: &Request) -> Result<(), rust_web_server::response::Response> {
    let Json(payload) = Json::<CreateUser>::from_request(req)?;
    // payload.name, payload.age
    Ok(())
}

§Serializing (typed struct → response)

use serde::Serialize;
use rust_web_server::json::Json;

#[derive(Serialize)]
struct UserResponse { id: u64, name: String }

let response = Json(UserResponse { id: 1, name: "Alice".into() }).into_response();

Tuple Fields§

§0: T

Implementations§

Source§

impl<T: DeserializeOwned> Json<T>

Source

pub fn from_request(request: &Request) -> Result<Json<T>, Response>

Deserialize T from the request body as JSON.

Returns a 400 Bad Request response on parse failure.

Source§

impl<T: Serialize> Json<T>

Source

pub fn into_response(self) -> Response

Serialize T as JSON and return a 200 OK response with Content-Type: application/json.

Returns 500 Internal Server Error if serialization fails (rare for well-formed Serialize implementations).

Trait Implementations§

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> Deref for Json<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<T> DerefMut for Json<T>

Source§

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

Mutably dereferences the value.
Source§

impl<T: DeserializeOwned> FromRequest for Json<T>

Source§

fn from_request(request: &Request) -> Result<Self, Response>

Extract Self from request, or return a ready-to-send error Response.
Source§

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

A handler may return Json<T> (18.28.0): 200 OK, application/json.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.