#[repr(transparent)]pub struct Xml<T>(pub T);xml only.Expand description
The XML guard: easily consume and return XML.
§Sending XML
To respond with serialized XML data, return a Xml<T> type, where T
implements Serialize from serde. The content type of the response is
set to text/xml; charset=utf-8 automatically.
use rocket::serde::{Serialize, xml::Xml};
#[derive(Serialize)]
#[serde(crate = "rocket::serde")]
struct User {
id: usize,
}
#[get("/users/<id>")]
fn user(id: usize) -> Xml<User> {
let user_from_id = User { id };
/* ... */
Xml(user_from_id)
}XML requires a root element, so T must serialize as a named element, such
as a struct or enum. Values without a name, like integers, strings,
sequences, and tuples, fail to serialize, resulting in a 500 response.
§Receiving XML
Xml is both a data guard and a form guard.
§Data Guard
To deserialize request body data as XML , add a data route argument with
a target type of Xml<T>, where T is some type you’d like to parse from
XML. T must implement serde::Deserialize.
use rocket::serde::xml::Xml;
#[post("/user", format = "xml", data = "<user>")]
fn new_user(user: Xml<User>) {
/* ... */
}The name of the root element is not checked: <Other>...</Other>
deserializes into a User just as <User>...</User> does.
You don’t need to use format = "xml", but it may be what you want.
Using format = xml means that any request that doesn’t specify
“text/xml” as its Content-Type header value will not be routed to
the handler. Use format = "*/xml" to accept both text/xml and
application/xml.
§Form Guard
Xml<T>, as a form guard, accepts value and data fields and parses the
data as a T. Simple use Xml<T>:
use rocket::form::{Form, FromForm};
use rocket::serde::xml::Xml;
#[derive(FromForm)]
struct User<'r> {
name: &'r str,
metadata: Xml<Metadata>
}
#[post("/user", data = "<form>")]
fn new_user(form: Form<User<'_>>) {
/* ... */
}§Incoming Data Limits
The default size limit for incoming XML 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.xml configuration parameter. For
instance, to increase the XML limit to 5MiB for all environments, you may
add the following to your Rocket.toml:
[global.limits]
xml = 5242880Tuple Fields§
§0: TImplementations§
Trait Implementations§
impl<T: Eq> Eq for Xml<T>
Source§impl<'r, T: Deserialize<'r>> FromData<'r> for Xml<T>
impl<'r, T: Deserialize<'r>> FromData<'r> for Xml<T>
Source§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
Self: 'async_trait,
'r: 'async_trait,
'life0: 'async_trait,
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
Self: 'async_trait,
'r: 'async_trait,
'life0: 'async_trait,
Self
from the incoming request body data. Read moreSource§impl<'v, T: Deserialize<'v> + Send> FromFormField<'v> for Xml<T>
impl<'v, T: Deserialize<'v> + Send> FromFormField<'v> for Xml<T>
Source§fn from_value(field: ValueField<'v>) -> Result<Self, Errors<'v>>
fn from_value(field: ValueField<'v>) -> Result<Self, Errors<'v>>
T from a form value field. Read moreSource§impl<'x, T: Serialize> FromUriParam<Query, &'x Xml<T>> for Xml<T>
impl<'x, T: Serialize> FromUriParam<Query, &'x Xml<T>> for Xml<T>
Source§fn from_uri_param(param: &'x Xml<T>) -> &'x Xml<T>
fn from_uri_param(param: &'x Xml<T>) -> &'x Xml<T>
T into a value of type Self::Target. The
resulting value of type Self::Target will be rendered into a URI using
its UriDisplay implementation.Source§impl<'x, T: Serialize> FromUriParam<Query, &'x mut Xml<T>> for Xml<T>
impl<'x, T: Serialize> FromUriParam<Query, &'x mut Xml<T>> for Xml<T>
Source§fn from_uri_param(param: &'x mut Xml<T>) -> &'x mut Xml<T>
fn from_uri_param(param: &'x mut Xml<T>) -> &'x mut Xml<T>
T into a value of type Self::Target. The
resulting value of type Self::Target will be rendered into a URI using
its UriDisplay implementation.Source§impl<T: Serialize> FromUriParam<Query, T> for Xml<T>
impl<T: Serialize> FromUriParam<Query, T> for Xml<T>
Source§fn from_uri_param(param: T) -> Self::Target
fn from_uri_param(param: T) -> Self::Target
T into a value of type Self::Target. The
resulting value of type Self::Target will be rendered into a URI using
its UriDisplay implementation.Source§impl<T: Serialize> FromUriParam<Query, Xml<T>> for Xml<T>
impl<T: Serialize> FromUriParam<Query, Xml<T>> for Xml<T>
Source§fn from_uri_param(param: Xml<T>) -> Xml<T>
fn from_uri_param(param: Xml<T>) -> Xml<T>
T into a value of type Self::Target. The
resulting value of type Self::Target will be rendered into a URI using
its UriDisplay implementation.Source§impl<T: Ord> Ord for Xml<T>
impl<T: Ord> Ord for Xml<T>
1.21.0 (const: unstable) · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.21.0 (const: unstable) · Source§fn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl<T: PartialOrd> PartialOrd for Xml<T>
impl<T: PartialOrd> PartialOrd for Xml<T>
Source§impl<'r, T: Serialize> Responder<'r, 'static> for Xml<T>
Serializes the wrapped value into XML. Returns a response with Content-Type
XML and a fixed-size body with the serialized value. If serialization
fails, an Err of Status::InternalServerError is returned.
impl<'r, T: Serialize> Responder<'r, 'static> for Xml<T>
Serializes the wrapped value into XML. Returns a response with Content-Type
XML and a fixed-size body with the serialized value. If serialization
fails, an Err of Status::InternalServerError is returned.
impl<T: PartialEq> StructuralPartialEq for Xml<T>
Auto Trait Implementations§
impl<T> Forget for Xml<T>
impl<T> Freeze for Xml<T>where
T: Freeze,
impl<T> Move for Xml<T>
impl<T> RefUnwindSafe for Xml<T>where
T: RefUnwindSafe,
impl<T> Send for Xml<T>where
T: Send,
impl<T> Sync for Xml<T>where
T: Sync,
impl<T> Unpin for Xml<T>where
T: Unpin,
impl<T> UnsafeUnpin for Xml<T>where
T: UnsafeUnpin,
impl<T> UnwindSafe for Xml<T>where
T: UnwindSafe,
Blanket Implementations§
Source§impl<T> AsAny for Twhere
T: Any,
impl<T> AsAny for Twhere
T: Any,
fn as_any_ref(&self) -> &(dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
impl<R> CryptoRng for R
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.impl<T> Formattable for T
Source§impl<'v, T> FromForm<'v> for Twhere
T: FromFormField<'v>,
impl<'v, T> FromForm<'v> for Twhere
T: FromFormField<'v>,
Source§fn init(opts: Options) -> <T as FromForm<'v>>::Context
fn init(opts: Options) -> <T as FromForm<'v>>::Context
Self.Source§fn push_value(ctxt: &mut <T as FromForm<'v>>::Context, field: ValueField<'v>)
fn push_value(ctxt: &mut <T as FromForm<'v>>::Context, field: ValueField<'v>)
field.Source§fn push_data<'life0, 'life1, 'async_trait>(
ctxt: &'life0 mut FromFieldContext<'v, T>,
field: DataField<'v, 'life1>,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
'v: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn push_data<'life0, 'life1, 'async_trait>(
ctxt: &'life0 mut FromFieldContext<'v, T>,
field: DataField<'v, 'life1>,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
'v: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
field.Source§fn finalize(ctxt: <T as FromForm<'v>>::Context) -> Result<T, Errors<'v>>
fn finalize(ctxt: <T as FromForm<'v>>::Context) -> Result<T, Errors<'v>>
Errors otherwise.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);impl<T> Parsable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
impl<R> RngCore for Rwhere
R: Rng,
Source§impl<R> RngExt for R
impl<R> RngExt for R
Source§fn random<T>(&mut self) -> Twhere
StandardUniform: Distribution<T>,
fn random<T>(&mut self) -> Twhere
StandardUniform: Distribution<T>,
StandardUniform distribution. Read moreSource§fn random_iter<T>(self) -> Iter<StandardUniform, Self, T> ⓘ
fn random_iter<T>(self) -> Iter<StandardUniform, Self, T> ⓘ
Source§fn random_range<T, R>(&mut self, range: R) -> Twhere
T: SampleUniform,
R: SampleRange<T>,
fn random_range<T, R>(&mut self, range: R) -> Twhere
T: SampleUniform,
R: SampleRange<T>,
Source§fn random_bool(&mut self, p: f64) -> bool
fn random_bool(&mut self, p: f64) -> bool
p of being true. Read moreSource§fn random_ratio(&mut self, numerator: u32, denominator: u32) -> bool
fn random_ratio(&mut self, numerator: u32, denominator: u32) -> bool
numerator/denominator of being
true. Read more