Struct hyperdrive::body::Json

pub struct Json<T: DeserializeOwned + Send + 'static>(pub T);

Decodes a JSON-encoded request body.

The FromBody implementation of this type will retrieve the request body and decode it as JSON using serde_json. The Content-Type and Content-Length headers are ignored.

Examples

#[derive(Deserialize)]
struct BodyData {
    id: u32,
    names: Vec<String>,
}

#[derive(FromRequest)]
enum Route {
    #[post("/json")]
    Index {
        #[body]
        data: Json<BodyData>,
    },
}

let data = r#"
{
    "id": 123,
    "names": [
        "Joachim",
        "Johannes",
        "Jonathan"
    ]
}
"#;

let Route::Index { data: Json(body) } = Route::from_request_sync(
    http::Request::post("/json").body(data.into()).unwrap(),
    NoContext,
).unwrap();

assert_eq!(body.id, 123);
assert_eq!(body.names, vec![
    "Joachim".to_string(),
    "Johannes".to_string(),
    "Jonathan".to_string(),
]);

Trait Implementations

impl<T: DeserializeOwned + Send + 'static> FromBody for Json<T>

type Context = NoContext

A context parameter passed to [from_body].

type Result = DefaultFuture<Self, BoxedError>

The result returned by [from_body].

fn from_body(
    _request: &Arc<Request<()>>,
    body: Body,
    _context: &Self::Context
) -> Self::Result

Create an instance of this type from an HTTP request body, asynchronously.

impl<T: PartialEq + DeserializeOwned + Send + 'static> PartialEq<Json<T>> for Json<T>

fn eq(&self, other: &Json<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Json<T>) -> bool

This method tests for !=.

impl<T: Eq + DeserializeOwned + Send + 'static> Eq for Json<T>

impl<T: DeserializeOwned + Send + 'static> DerefMut for Json<T>

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

Mutably dereferences the value.

impl<T: DeserializeOwned + Send + 'static> Deref for Json<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Debug + DeserializeOwned + Send + 'static> Debug for Json<T>

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

Formats the value using the given formatter.