Enum JsonBody

pub enum JsonBody<T> {
    Error(Option<JsonPayloadError>),
    Body {
        limit: usize,
        length: Option<usize>,
        payload: Decompress<Payload>,
        buf: BytesMut,
        _res: PhantomData<T>,
    },
}

Future that resolves to some T when parsed from a JSON payload.

Can deserialize any type T that implements Deserialize.

Returns error if:

• Content-Type is not application/json when ctype_required (passed to new) is true.
• Content-Length is greater than limit.
• The payload, when consumed, is not valid JSON.

Variants

Error(Option<JsonPayloadError>)

Body

Fields

limit: usize

length: Option<usize>

Length as reported by Content-Length header, if present.

payload: Decompress<Payload>

buf: BytesMut

_res: PhantomData<T>

Implementations

impl<T: DeserializeOwned> JsonBody<T>

pub fn new( req: &HttpRequest, payload: &mut Payload, ctype_fn: Option<&(dyn Fn(Mime) -> bool + Send + Sync)>, ctype_required: bool, ) -> Self

Create a new future to decode a JSON request payload.

pub fn limit(self, limit: usize) -> Self

Set maximum accepted payload size. The default limit is 2MB.

Trait Implementations

impl<T: DeserializeOwned> Future for JsonBody<T>

type Output = Result<T, JsonPayloadError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<T> Unpin for JsonBody<T>