Struct nebula_form::Form

pub struct Form(_);

Represents the entire contents of a submitted form.

Implementations

impl Form

pub fn new() -> Form

Creates a new empty form instance.

pub fn with_capacity(cap: usize) -> Form

Creates a new empty form instance with the given capacity.

pub fn insert(&mut self, name: &str, field: Field) -> Option<Field>

Adds a new Field to the Form. Returns the previous Field, if there was one.

pub fn remove(&mut self, name: &str) -> Option<Field>

If a Field exists with the given name, it is removed and returned. Otherwise, nothing happens and None is returned.

pub fn clear(&mut self)

Empties the contents of the Form.

pub fn get(&self, name: &str) -> Option<&Field>

Returns a reference to the field contents, if the field exists.

pub fn extend(&mut self, iter: impl Iterator<Item = (String, Field)>)

Append the contents of a map to the current Form. Fields that already exist will be overwritten.

pub fn extend_from_strings(
    &mut self,
    iter: impl Iterator<Item = (String, String)>
)

Append the contents of a map to the current Form, converting the String values to a Field::Text. Fields that already exist will be overwritten.

pub fn contains_field(&self, field: &str) -> bool

Indicates whether this Form contains a field with the given name.

pub fn is_empty(&self) -> bool

Indicates whether the Form is empty (i.e., has no fields).

pub fn len(&self) -> usize

Returns the length of the Form (i.e., the number of fields).

pub fn iter(&self) -> impl Iterator<Item = (&String, &Field)>

Returns an iterator over every field in the form.

pub fn iter_text(&self) -> impl Iterator<Item = (&String, &Field)>

Returns an iterator over every text field in the form.

pub fn iter_files(&self) -> impl Iterator<Item = (&String, &Field)>

Returns an iterator over every file field in the form.

pub fn to_url_encoded(&self) -> Result<String, String>

Returns the Form to a URL encoded format, suitable for GET requests or the body of a Content-Type: application/x-www-form-urlencoded POST request.

pub fn to_multipart_bytes(&self, boundary: &[u8]) -> Vec<u8>

Returns the Form in multipart format, i.e. the format suitable for the body of a request with Content-Type: multipart/form-data.

Trait Implementations

impl Debug for Form

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

Formats the value using the given formatter.

impl Default for Form

fn default() -> Form

Returns the "default value" for a type.

impl From<HashMap<String, String, RandomState>> for Form

fn from(map: HashMap<String, String>) -> Self

Performs the conversion.

impl PartialEq<Form> for Form

fn eq(&self, other: &Form) -> bool

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

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

This method tests for !=.

impl StructuralPartialEq for Form