[][src]Struct rocket_contrib::json::Json

pub struct Json<T>(pub T);

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

Receiving JSON

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

use rocket_contrib::json::Json;

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

You don't need to use format = "json", but it may be what you want. Using format = json means that any request that doesn't specify "application/json" as its Content-Type header value will not be routed to the handler.

Sending JSON

If you're responding with JSON data, return a Json<T> type, where T implements Serialize from serde. The content type of the response is set to application/json automatically.

use rocket_contrib::json::Json;

#[get("/users/<id>")]
fn user(id: usize) -> Json<User> {
    let user_from_id = User::from(id);
    /* ... */
    Json(user_from_id)
}

Incoming Data Limits

The default size limit for incoming JSON 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.json configuration parameter. For instance, to increase the JSON limit to 5MiB for all environments, you may add the following to your Rocket.toml:

[global.limits]
json = 5242880

Methods

impl<T> Json<T>[src]

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

Consumes the JSON wrapper and returns the wrapped item.

Example

let string = "Hello".to_string();
let my_json = Json(string);
assert_eq!(my_json.into_inner(), "Hello".to_string());

Trait Implementations

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

type Target = T

The resulting type after dereferencing.

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

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

impl<'a, T: Deserialize<'a>> FromData<'a> for Json<T>[src]

type Error = JsonError<'a>

The associated error to be returned when the guard fails.

type Owned = String

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

type Borrowed = str

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

impl<'a, T: Serialize> Responder<'a> for Json<T>[src]

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

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

impl<T> Typeable for T where
    T: Any

fn get_type(&self) -> TypeId

Get the TypeId of this object.

impl<'a, T> FromData<'a> for T where
    T: FromDataSimple
[src]

type Error = <T as FromDataSimple>::Error

The associated error to be returned when the guard fails.

type Owned = Data

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

type Borrowed = Data

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

impl<T> IntoCollection<T> for T

impl<T, I> AsResult<T, I> for T where
    I: Input, 

impl<T> IntoSql for T

fn into_sql<T>(self) -> Self::Expression where
    Self: AsExpression<T>, 

Convert self to an expression for Diesel's query builder. Read more

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression where
    &'a Self: AsExpression<T>, 

Convert &self to an expression for Diesel's query builder. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Erased for T

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

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