Struct Field

pub struct Field { /* private fields */ }

A single field in a multipart stream

Implementations

impl Field

pub fn headers(&self) -> &HeaderMap

Returns a reference to the field’s header map.

pub fn content_type(&self) -> Option<&Mime>

Returns a reference to the field’s content (mime) type, if it is supplied by the client.

According to RFC 7578, if it is not present, it should default to “text/plain”. Note it is the responsibility of the client to provide the appropriate content type, there is no attempt to validate this by the server.

pub fn content_disposition(&self) -> &ContentDisposition

Returns the field’s Content-Disposition.

Per RFC 7578 §4.2: “Each part MUST contain a Content-Disposition header field where the disposition type is form-data. The Content-Disposition header field MUST also contain an additional parameter of name; the value of the name parameter is the original field name from the form.”

This crate validates that it exists before returning a Field. As such, it is safe to unwrap .content_disposition().get_name(). The name method is provided as a convenience.

pub fn name(&self) -> &str

Returns the field’s name.

See content_disposition regarding guarantees about existence of the name field.

Trait Implementations

impl Debug for Field

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

Formats the value using the given formatter.

impl Stream for Field

type Item = Result<Bytes, MultipartError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.