Struct saphir::multipart::Field

pub struct Field<'f> { /* private fields */ }

Available on crate feature multipart only.

Represent a form-data field Only the data needed to construct the field will be read into memory

Implementations

impl<'f> Field<'f>

pub fn name(&self) -> &str

Returns the name param of the Content-Disposition header.

Currently return "" if the name is missing.

This will return an Option<*str> in saphir 4.0.0

pub fn filename(&self) -> Option<&str>

Returns the optional filename param of the Content-Disposition header

pub fn content_type(&self) -> &Mime

Returns the optional Content-Type Mime and is defaulted to text/plain as specified by the spec

pub async fn as_raw(&mut self) -> Result<Vec<u8>, MultipartError>

👎Deprecated since 3.1.0: Use to_raw() instead.

Deprecated; Use to_raw() instead.

Loads the entire field into memory and returns it as raw bytes

This will be removed in saphir 4.0.0

pub async fn to_raw(self) -> Result<Vec<u8>, MultipartError>

Loads the entire field into memory and returns it as raw bytes

pub async fn as_text(&mut self) -> Result<String, MultipartError>

👎Deprecated since 3.1.0: use to_text() instead

Deprecated; Use to_raw() instead.

Loads the entire field into memory and returns it as plain text

This will be removed in saphir 4.0.0

pub async fn to_text(self) -> Result<String, MultipartError>

Loads the entire field into memory and returns it as plain text

pub async fn as_json<T>(&mut self) -> Result<Option<T>, MultipartError>where T: for<'a> Deserialize<'a>,

👎Deprecated since 3.1.0: use to_json() instead

Available on crate feature json only.

Deprecated; Use to_raw() instead.

Loads the entire field into memory and parses it as JSON data IF the content-type is application/json.

Return Ok(None) if the content-type was incorrect.

This will be removed in saphir 4.0.0

pub async fn to_json<T>(self) -> Result<Option<T>, MultipartError>where T: for<'a> Deserialize<'a>,

👎Deprecated since 3.1.0: use to_json() instead

Available on crate feature json only.

Loads the entire field into memory and parses it as JSON data IF the content-type is application/json.

Return Ok(None) if the content-type was incorrect.

pub async fn as_form<T>(&mut self) -> Result<Option<T>, MultipartError>where T: for<'a> Deserialize<'a>,

👎Deprecated since 3.1.0: use to_form() instead

Available on crate feature form only.

Deprecated; Use to_raw() instead.

Loads the entire field into memory and parses it as Form urlencoded data IF the content-type is application/x-www-form-urlencoded.

Return Ok(None) if the content-type was incorrect.

This will be removed in saphir 4.0.0

pub async fn to_form<T>(self) -> Result<Option<T>, MultipartError>where T: for<'a> Deserialize<'a>,

Available on crate feature form only.

Loads the entire field into memory and parses it as Form urlencoded data IF the content-type is application/x-www-form-urlencoded.

Return Ok(None) if the content-type was incorrect.

pub async fn save<P: AsRef<Path>>( &mut self, path: P ) -> Result<usize, MultipartError>

Saves the field into a file on disk.

This function will consume the field in saphir 4.0.0

Trait Implementations

impl Debug for Field<'_>

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

Formats the value using the given formatter.

impl<'f> From<Field<'f>> for Field<'f>

fn from(raw: RawField<'f>) -> Self

Converts to this type from the input type.