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) -> Option<&ContentDisposition>

Returns this field’s parsed Content-Disposition header, if set.

Validation

Per RFC 7578 §4.2, the parts of a multipart/form-data payload MUST contain a Content-Disposition header field where the disposition type is form-data and MUST also contain an additional parameter of name with its value being the original field name from the form. This requirement is enforced during extraction for multipart/form-data requests, but not other kinds of multipart requests (such as multipart/related).

As such, it is safe to .unwrap() calls .content_disposition() if you’ve verified.

The name() method is also provided as a convenience for obtaining the aforementioned name parameter.

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

Returns the field’s name, if set.

See content_disposition() regarding guarantees on presence of the “name” field.

pub async fn bytes( &mut self, limit: usize, ) -> Result<Result<Bytes, Error>, LimitExceeded>

Collects the raw field data, up to limit bytes.

Errors

Any errors produced by the data stream are returned as Ok(Err(Error)) immediately.

If the buffered data size would exceed limit, an Err(LimitExceeded) is returned. Note that, in this case, the full data stream is exhausted before returning the error so that subsequent fields can still be read. To better defend against malicious/infinite requests, it is advisable to also put a timeout on this call.

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, Error>

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.