Struct Multipart

pub struct Multipart { /* private fields */ }

Available on crate feature multipart only.

Extractor that parses multipart/form-data requests (commonly used with file uploads).

⚠️ Since extracting multipart form data from the request requires consuming the body, the Multipart extractor must be last if there are multiple extractors in a handler. See “the order of extractors”

Example

use axum::{
    extract::Multipart,
    routing::post,
    Router,
};
use futures_util::stream::StreamExt;

async fn upload(mut multipart: Multipart) {
    while let Some(mut field) = multipart.next_field().await.unwrap() {
        let name = field.name().unwrap().to_string();
        let data = field.bytes().await.unwrap();

        println!("Length of `{}` is {} bytes", name, data.len());
    }
}

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

Large Files

For security reasons, by default, Multipart limits the request body size to 2MB. See DefaultBodyLimit for how to configure this limit.

Implementations

impl Multipart

pub async fn next_field(&mut self) -> Result<Option<Field<'_>>, MultipartError>

Yields the next Field if available.

Trait Implementations

impl Debug for Multipart

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

Formats the value using the given formatter.

impl<S> FromRequest<S> for Multipart

where S: Send + Sync,

type Rejection = MultipartRejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request<'life0, 'async_trait>( req: Request, _state: &'life0 S, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Perform the extraction.