Struct rocket_contrib::msgpack::MsgPack

pub struct MsgPack<T>(pub T);

The MsgPack type: implements FromData and Responder, allowing you to easily consume and respond with MessagePack data.

Receiving MessagePack

If you're receiving MessagePack data, simply add a data parameter to your route arguments and ensure the type of the parameter is a MsgPack<T>, where T is some type you'd like to parse from MessagePack. T must implement Deserialize from serde. The data is parsed from the HTTP request body.

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.

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;

#[get("/users/<id>")]
fn user(id: usize) -> MsgPack<User> {
    let user_from_id = User::from(id);
    /* ... */
    MsgPack(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:

[global.limits]
msgpack = 5242880

Methods

impl<T> MsgPack<T>

pub fn into_inner(self) -> T

Consumes the MsgPack wrapper and returns the wrapped item.

Example

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

Trait Implementations

impl<T> DerefMut for MsgPack<T>

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

Mutably dereferences the value.

impl<T> Deref for MsgPack<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Debug> Debug for MsgPack<T>

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

Formats the value using the given formatter.

impl<'a, T: Deserialize<'a>> FromData<'a> for MsgPack<T>

type Error = Error

The associated error to be returned when the guard fails.

type Owned = Vec<u8>

The owned type returned from [FromData::transform()].

type Borrowed = [u8]

The borrowed type consumed by [FromData::from_data()] when [FromData::transform()] returns a [Transform::Borrowed].

fn transform(
    r: &Request,
    d: Data
) -> Transform<Outcome<Self::Owned, Self::Error>>

Transforms data into a value of type Self::Owned.

fn from_data(
    _: &Request,
    o: Transformed<'a, Self>
) -> Outcome<Self, Self::Error>

Validates, parses, and converts the incoming request body data into an instance of Self.

impl<T: Serialize> Responder<'static> for MsgPack<T>

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, _: &Request) -> Result<'static>

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