Struct axum::extract::multipart::Field

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

Available on crate feature multipart only.

A single field in a multipart stream.

Implementations

impl<'a> Field<'a>

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

The field name found in the Content-Disposition header.

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

The file name found in the Content-Disposition header.

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

Get the content type of the field.

pub fn headers(&self) -> &HeaderMap

Get a map of headers as HeaderMap.

pub async fn bytes(self) -> Result<Bytes, MultipartError>

Get the full data of the field as Bytes.

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

Get the full field data as text.

pub async fn chunk(&mut self) -> Result<Option<Bytes>, MultipartError>

Stream a chunk of the field data.

When the field data has been exhausted, this will return None.

Note this does the same thing as Field’s [Stream] implementation.

Example

use axum::{
   extract::Multipart,
   routing::post,
   response::IntoResponse,
   http::StatusCode,
   Router,
};

async fn upload(mut multipart: Multipart) -> Result<(), (StatusCode, String)> {
    while let Some(mut field) = multipart
        .next_field()
        .await
        .map_err(|err| (StatusCode::BAD_REQUEST, err.to_string()))?
    {
        while let Some(chunk) = field
            .chunk()
            .await
            .map_err(|err| (StatusCode::BAD_REQUEST, err.to_string()))?
        {
            println!("received {} bytes", chunk.len());
        }
    }

    Ok(())
}

let app = Router::new().route("/upload", post(upload));

Trait Implementations

impl<'a> Debug for Field<'a>

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

Formats the value using the given formatter.

impl<'a> Stream for Field<'a>

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.