Struct rocket::request::FormItem

pub struct FormItem<'f> {
    pub raw: &'f RawStr,
    pub key: &'f RawStr,
    pub value: &'f RawStr,
}

A form items returned by the FormItems iterator.

Fields

raw: &'f RawStr

The full, nonempty string for the item, not including & delimiters.

key: &'f RawStr

The key for the item, which may be empty if value is nonempty.

Note: The key is not URL decoded. To URL decode the raw strings, use the RawStr::url_decode() method or access key-value pairs with key_value_decoded().

value: &'f RawStr

The value for the item, which may be empty if key is nonempty.

Note: The value is not URL decoded. To URL decode the raw strings, use the RawStr::url_decode() method or access key-value pairs with key_value_decoded().

Methods

impl<'f> FormItem<'f>

pub fn key_value(&self) -> (&'f RawStr, &'f RawStr)

Extracts the raw key and value as a tuple.

This is equivalent to (item.key, item.value).

Example

use rocket::request::FormItem;

let item = FormItem {
    raw: "hello=%2C+world%21".into(),
    key: "hello".into(),
    value: "%2C+world%21".into(),
};

let (key, value) = item.key_value();
assert_eq!(key, "hello");
assert_eq!(value, "%2C+world%21");

pub fn key_value_decoded(&self) -> (String, String)

Extracts and lossy URL decodes the key and value as a tuple.

This is equivalent to (item.key.url_decode_lossy(), item.value.url_decode_lossy).

Example

use rocket::request::FormItem;

let item = FormItem {
    raw: "hello=%2C+world%21".into(),
    key: "hello".into(),
    value: "%2C+world%21".into(),
};

let (key, value) = item.key_value_decoded();
assert_eq!(key, "hello");
assert_eq!(value, ", world!");

pub fn explode(&self) -> (&'f RawStr, &'f RawStr, &'f RawStr)

Extracts raw and the raw key and value as a triple.

This is equivalent to (item.raw, item.key, item.value).

Example

use rocket::request::FormItem;

let item = FormItem {
    raw: "hello=%2C+world%21".into(),
    key: "hello".into(),
    value: "%2C+world%21".into(),
};

let (raw, key, value) = item.explode();
assert_eq!(raw, "hello=%2C+world%21");
assert_eq!(key, "hello");
assert_eq!(value, "%2C+world%21");

Trait Implementations

impl<'f> PartialEq<FormItem<'f>> for FormItem<'f>

fn eq(&self, other: &FormItem<'f>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FormItem<'f>) -> bool

This method tests for !=.

impl<'f> Copy for FormItem<'f>

impl<'f> Eq for FormItem<'f>

impl<'f> Clone for FormItem<'f>

fn clone(&self) -> FormItem<'f>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'f> Debug for FormItem<'f>

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

Formats the value using the given formatter.