Struct rocket::serde::msgpack::MsgPack[][src]

pub struct MsgPack<T>(pub T);
This is supported on crate feature msgpack only.
Expand description

The MessagePack guard: easily consume and return MessagePack.

Receiving MessagePack

MsgPack is both a data guard and a form guard.

Data Guard

To parse request body data as MessagePack , add a data route argument with a target type of MsgPack<T>, where T is some type you’d like to parse from JSON. T must implement serde::Deserialize.

use rocket::serde::msgpack::MsgPack;

#[post("/users", format = "msgpack", data = "<user>")]
fn new_user(user: MsgPack<User>) {
    /* ... */

You don’t need to use format = "msgpack", but it may be what you want. Using format = msgpack means that any request that doesn’t specify “application/msgpack” as its first Content-Type: header parameter will not be routed to this handler.

Form Guard

MsgPack<T>, as a form guard, accepts value and data fields and parses the data as a T. Simple use MsgPack<T>:

use rocket::form::{Form, FromForm};
use rocket::serde::msgpack::MsgPack;

struct User<'r> {
    name: &'r str,
    metadata: MsgPack<Metadata>

#[post("/users", data = "<form>")]
fn new_user(form: Form<User<'_>>) {
    /* ... */

Incoming Data Limits

The default size limit for incoming MessagePack data is 1MiB. Setting a limit protects your application from denial of service (DOS) attacks and from resource exhaustion through high memory consumption. The limit can be increased by setting the limits.msgpack configuration parameter. For instance, to increase the MessagePack limit to 5MiB for all environments, you may add the following to your Rocket.toml:

msgpack = 5242880

Sending MessagePack

If you’re responding with MessagePack data, return a MsgPack<T> type, where T implements Serialize from serde. The content type of the response is set to application/msgpack automatically.

use rocket::serde::msgpack::MsgPack;

fn user(id: usize) -> MsgPack<User> {
    let user_from_id = User::from(id);
    /* ... */


impl<T> MsgPack<T>[src]

pub fn into_inner(self) -> T[src]

Consumes the MsgPack wrapper and returns the wrapped item.


let string = "Hello".to_string();
let my_msgpack = MsgPack(string);
assert_eq!(my_msgpack.into_inner(), "Hello".to_string());

Trait Implementations

impl<T: Debug> Debug for MsgPack<T>[src]

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

Formats the value using the given formatter. Read more

impl<T> Deref for MsgPack<T>[src]

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T[src]

Dereferences the value.

impl<T> DerefMut for MsgPack<T>[src]

fn deref_mut(&mut self) -> &mut T[src]

Mutably dereferences the value.

impl<T> From<T> for MsgPack<T>[src]

fn from(value: T) -> Self[src]

Performs the conversion.

impl<'r, T: Deserialize<'r>> FromData<'r> for MsgPack<T>[src]

type Error = Error

The associated error to be returned when the guard fails.

fn from_data<'life0, 'async_trait>(
    req: &'r Request<'life0>,
    data: Data<'r>
) -> Pin<Box<dyn Future<Output = Outcome<'r, Self>> + Send + 'async_trait>> where
    'r: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Asynchronously validates, parses, and converts an instance of Self from the incoming request body data. Read more

impl<'v, T: Deserialize<'v> + Send> FromFormField<'v> for MsgPack<T>[src]

fn from_data<'life0, 'async_trait>(
    f: DataField<'v, 'life0>
) -> Pin<Box<dyn Future<Output = Result<Self, Errors<'v>>> + Send + 'async_trait>> where
    'v: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Parse a value of T from a form data field. Read more

fn from_value(field: ValueField<'v>) -> Result<'v, Self>[src]

Parse a value of T from a form value field. Read more

fn default() -> Option<Self>[src]

Returns a default value, if any exists, to be used during lenient parsing when the form field is missing. Read more

impl<'r, T: Serialize> Responder<'r, 'static> for MsgPack<T>[src]

Serializes the wrapped value into MessagePack. Returns a response with Content-Type MsgPack and a fixed-size body with the serialization. If serialization fails, an Err of Status::InternalServerError is returned.

fn respond_to(self, req: &'r Request<'_>) -> Result<'static>[src]

Returns Ok if a Response could be generated successfully. Otherwise, returns an Err with a failing Status. Read more

Auto Trait Implementations

impl<T> RefUnwindSafe for MsgPack<T> where
    T: RefUnwindSafe

impl<T> Send for MsgPack<T> where
    T: Send

impl<T> Sync for MsgPack<T> where
    T: Sync

impl<T> Unpin for MsgPack<T> where
    T: Unpin

impl<T> UnwindSafe for MsgPack<T> where
    T: UnwindSafe

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<!> for T[src]

pub fn from(t: !) -> T[src]

Performs the conversion.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

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

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

fn in_current_span(self) -> Instrumented<Self>[src]

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

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> IntoCollection<T> for T

pub fn into_collection<A>(self) -> SmallVec<A> where
    A: Array<Item = T>, 

Converts self into a collection.

pub fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
    F: FnMut(T) -> U,
    A: Array<Item = U>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V