Struct UrlEncoded

#[repr(transparent)]
pub struct UrlEncoded<T>(pub T);

The UrlEncoded guard: easily consume x-www-form-urlencoded requests.

Receiving

UrlEncoded is both a data guard and a form guard.

Data Guard

To deserialize request body data from x-www-form-urlencoded, add a data route argument with a target type of UrlEncoded<T>, where T is some type you’d like to parse. T must implement serde::Deserialize. See serde_urlencoded docs on the flatten-workaround for important hints about more complex datatypes.

use rocket_enumform::UrlEncoded;

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

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

Incoming Data Limits

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

[global.limits]
form = 5242880

Tuple Fields

0: T

Implementations

impl<T> UrlEncoded<T>

pub fn into_inner(self) -> T

Consumes the UrlEncoded wrapper and returns the wrapped item.

Example

use rocket_enumform::UrlEncoded;
let string = "Hello".to_string();
let outer = UrlEncoded(string);
assert_eq!(outer.into_inner(), "Hello".to_string());

Trait Implementations

impl<T: Clone> Clone for UrlEncoded<T>

fn clone(&self) -> UrlEncoded<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for UrlEncoded<T>

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

Formats the value using the given formatter.

impl<T> Deref for UrlEncoded<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for UrlEncoded<T>

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

Mutably dereferences the value.

impl<T> From<T> for UrlEncoded<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<'r, T: Deserialize<'r>> FromData<'r> for UrlEncoded<T>

type Error = Error<'r>

The associated error to be returned when the guard fails.

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,

Asynchronously validates, parses, and converts an instance of Self from the incoming request body data.

impl<'v, T: Deserialize<'v> + Send> FromFormField<'v> for UrlEncoded<T>

fn from_value(field: ValueField<'v>) -> Result<Self, Errors<'v>>

Parse a value of T from a form value field.

fn from_data<'life0, 'async_trait>( f: DataField<'v, 'life0>, ) -> Pin<Box<dyn Future<Output = Result<Self, Errors<'v>>> + Send + 'async_trait>>

where Self: 'async_trait, 'v: 'async_trait, 'life0: 'async_trait,

Parse a value of T from a form data field.

fn default() -> Option<Self>

Returns a default value, if any exists, to be used during lenient parsing when the form field is missing.

impl<'a, T: Serialize> FromUriParam<Query, &'a T> for UrlEncoded<T>

type Target = UrlEncoded<&'a T>

The resulting type of this conversion.

fn from_uri_param(param: &'a T) -> Self::Target

Converts a value of type 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.

impl<'x, T: Serialize> FromUriParam<Query, &'x UrlEncoded<T>> for UrlEncoded<T>

type Target = &'x UrlEncoded<T>

The resulting type of this conversion.

fn from_uri_param(param: &'x UrlEncoded<T>) -> &'x UrlEncoded<T>

Converts a value of type 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.

impl<'a, T: Serialize> FromUriParam<Query, &'a mut T> for UrlEncoded<T>

type Target = UrlEncoded<&'a mut T>

The resulting type of this conversion.

fn from_uri_param(param: &'a mut T) -> Self::Target

Converts a value of type 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.

impl<'x, T: Serialize> FromUriParam<Query, &'x mut UrlEncoded<T>> for UrlEncoded<T>

type Target = &'x mut UrlEncoded<T>

The resulting type of this conversion.

fn from_uri_param(param: &'x mut UrlEncoded<T>) -> &'x mut UrlEncoded<T>

Converts a value of type 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.

impl<T: Serialize> FromUriParam<Query, T> for UrlEncoded<T>

type Target = UrlEncoded<T>

The resulting type of this conversion.

fn from_uri_param(param: T) -> Self::Target

Converts a value of type 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.

impl<T: Serialize> FromUriParam<Query, UrlEncoded<T>> for UrlEncoded<T>

type Target = UrlEncoded<T>

The resulting type of this conversion.

fn from_uri_param(param: UrlEncoded<T>) -> UrlEncoded<T>

Converts a value of type 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.

impl<T: Hash> Hash for UrlEncoded<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for UrlEncoded<T>

fn cmp(&self, other: &UrlEncoded<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for UrlEncoded<T>

fn eq(&self, other: &UrlEncoded<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for UrlEncoded<T>

fn partial_cmp(&self, other: &UrlEncoded<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'r, T: Serialize> Responder<'r, 'static> for UrlEncoded<T>

Serializes the wrapped value into UrlEncoding. Returns a response with Content-Type application/x-www-form-urlencode and a fixed-size body with the serialized value. If serialization fails, an Err of Status::InternalServerError is returned.

fn respond_to(self, req: &'r Request<'_>) -> Result<'static>

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

impl<T: Serialize> UriDisplay<Query> for UrlEncoded<T>

fn fmt(&self, f: &mut UriFormatter<'_, Query>) -> Result

Formats self in a URI-safe manner using the given formatter.

impl<T: Eq> Eq for UrlEncoded<T>

impl<T> StructuralPartialEq for UrlEncoded<T>