[−][src]Struct rocket_contrib::json::Json
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: Debug> Debug for Json<T>
[src]
impl<T> Deref 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
fn transform(
r: &Request,
d: Data
) -> Transform<Outcome<Self::Owned, Self::Error>>
[src]
r: &Request,
d: Data
) -> Transform<Outcome<Self::Owned, Self::Error>>
fn from_data(
_: &Request,
o: Transformed<'a, Self>
) -> Outcome<Self, Self::Error>
[src]
_: &Request,
o: Transformed<'a, Self>
) -> Outcome<Self, Self::Error>
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.
fn respond_to(self, req: &Request) -> Result<'a>
[src]
Auto Trait Implementations
impl<T> RefUnwindSafe for Json<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> Send for Json<T> where
T: Send,
T: Send,
impl<T> Sync for Json<T> where
T: Sync,
T: Sync,
impl<T> Unpin for Json<T> where
T: Unpin,
T: Unpin,
impl<T> UnwindSafe for Json<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T, I> AsResult<T, I> for T where
I: Input,
I: Input,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<'a, T> FromData<'a> for T where
T: FromDataSimple,
[src]
T: FromDataSimple,
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
fn transform(
&Request,
d: Data
) -> Transform<Outcome<<T as FromData<'a>>::Owned, (Status, <T as FromData<'a>>::Error), Data>, Outcome<<T as FromData<'a>>::Owned, (Status, <T as FromData<'a>>::Error), Data>>
[src]
&Request,
d: Data
) -> Transform<Outcome<<T as FromData<'a>>::Owned, (Status, <T as FromData<'a>>::Error), Data>, Outcome<<T as FromData<'a>>::Owned, (Status, <T as FromData<'a>>::Error), Data>>
fn from_data(
req: &Request,
o: Transform<Outcome<<T as FromData<'a>>::Owned, (Status, <T as FromData<'a>>::Error), Data>, Outcome<&'a <T as FromData<'a>>::Borrowed, (Status, <T as FromData<'a>>::Error), Data>>
) -> Outcome<T, (Status, <T as FromData<'a>>::Error), Data>
[src]
req: &Request,
o: Transform<Outcome<<T as FromData<'a>>::Owned, (Status, <T as FromData<'a>>::Error), Data>, Outcome<&'a <T as FromData<'a>>::Borrowed, (Status, <T as FromData<'a>>::Error), Data>>
) -> Outcome<T, (Status, <T as FromData<'a>>::Error), Data>
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> IntoCollection<T> for T
fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
A: Array<Item = T>,
fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
A: Array<Item = U>,
F: FnMut(T) -> U,
A: Array<Item = U>,
F: FnMut(T) -> U,
impl<T> IntoSql for T
fn into_sql<T>(self) -> Self::Expression where
Self: AsExpression<T>,
Self: AsExpression<T>,
fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression where
&'a Self: AsExpression<T>,
&'a Self: AsExpression<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>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
U: TryFrom<T>,
impl<T> Typeable for T where
T: Any,
T: Any,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,