Struct Multipart 

pub struct Multipart { /* private fields */ }

Available on crate feature multipart only.

Extractor for multipart/form-data request bodies.

Iterate fields with Multipart::next_field. Per-field limits are configured via MultipartConfig, either inserted as a request extension by a layer (the path the extractor reads) or passed to from_body_with_config for direct use. Combine multiple configs with MultipartConfig::merge_floor; the lowest limit per field wins.

Multipart enforces field exclusivity at compile time: each Field borrows from &mut self, so the previous field must be dropped before the next is requested.

For producing multipart bodies on the client, see crate::service::client::multipart.

Implementations

impl Multipart

pub fn from_body(body: Body, boundary: impl Into<String>) -> Self

Build a Multipart from a body and boundary string with no per-field limits.

pub fn from_body_with_config( body: Body, boundary: impl Into<String>, config: Option<&MultipartConfig>, ) -> Self

Build a Multipart from a body and boundary string, applying the per-field limits in config. Pass None to skip building any multer::Constraints and use parser defaults.

pub fn from_stream_with_config<S, O, E, B>( stream: S, boundary: B, config: Option<&MultipartConfig>, ) -> Self

where S: Stream<Item = Result<O, E>> + Send + 'static, O: Into<Bytes> + 'static, E: Into<Box<dyn Error + Send + Sync>> + 'static, B: Into<String>,

Construct from any stream of Result<Bytes, _> and a boundary, with the per-field limits in config. Pass None to skip building any multer::Constraints and use parser defaults.

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

Yield the next Field in the multipart stream, or None if the stream is exhausted.

The previous Field must be dropped before this returns; the borrow checker enforces this.

Trait Implementations

impl Debug for Multipart

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

Formats the value using the given formatter.

impl FromRequest for Multipart

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.

async fn from_request(req: Request) -> Result<Self, Self::Rejection>

Perform the extraction.