Struct rocket_contrib::msgpack::MsgPack[][src]

pub struct MsgPack<T>(pub T);

The MsgPack data guard and responder: easily consume and respond with 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_contrib::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_contrib::msgpack::MsgPack;

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

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

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_contrib::msgpack::MsgPack;

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

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


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]

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

type Target = T

The resulting type after dereferencing.

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

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

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

type Error = Error

The associated error to be returned when the guard fails.

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

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.

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

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

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

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

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

impl<'v, T> FromForm<'v> for T where
    T: FromFormField<'v>, 

type Context = FromFieldContext<'v, T>

The form guard’s parsing context.

impl<T> Instrument for T[src]

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

impl<T> IntoCollection<T> for T

impl<T> IntoSql for T

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.

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.

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