Struct seamless::router::Json

pub struct Json<T> {
    pub json: T,
}

If the last argument to the handler is this, we'll assume that the user needs to provide JSON that decodes to T. Notably, T needs to implement ApiBody with the Deserialize option.

Fields

json: T

the type that has been deserialized from JSON.

Trait Implementations

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

pub fn api_body_type() -> ApiBodyType

This returns information about the shape of the type and description of parts of it.

pub fn to_json_vec(&self) -> Vec<u8> where
    Self: Serialize, 

Serialize the type to JSON.

pub fn to_json_value(&self) -> Value where
    Self: Serialize, 

Serialize the type to a serde_json::Value.

pub fn from_json_slice(bytes: &[u8]) -> Result<Self> where
    Self: DeserializeOwned, 

Deserialize from bytes containing a JSON value.

pub fn from_json_value(value: Value) -> Result<Self> where
    Self: DeserializeOwned, 

Deserialize from a serde_json::Value.

impl<T> Body for Json<T> where
    T: DeserializeOwned, 

type Error = ApiError

The type of the error returned if Self::get_body() fails.

pub fn get_body(req: Request<Vec<u8>>) -> Result<Self, ApiError>

Given a request containing arbitrary bytes, this function needs to return an instance of the type that this trait is implemented on (typically by deserializing it from the bytes provided), or else it should return an error describing what went wrong.

pub fn get_method() -> Method

Which HTTP method is required for this Body to be valid. By default, if a body is present in the handler we'll expect the method to be POST. Implement this function to override that.