Struct actix_multipart::Multipart

pub struct Multipart { /* fields omitted */ }

The server-side implementation of multipart/form-data requests.

This will parse the incoming stream into MultipartItem instances via its Stream implementation. MultipartItem::Field contains multipart field. MultipartItem::Multipart is used for nested multipart streams.

Implementations

impl Multipart

pub fn new<S>(headers: &HeaderMap, stream: S) -> Multipart where
    S: Stream<Item = Result<Bytes, PayloadError>> + Unpin + 'static, 

Create multipart instance for boundary.

Trait Implementations

impl FromRequest for Multipart

Get request's payload as multipart stream

Content-type: multipart/form-data;

Server example

use futures_util::stream::{Stream, StreamExt};
use actix_web::{web, HttpResponse, Error};
use actix_multipart as mp;

async fn index(mut payload: mp::Multipart) -> Result<HttpResponse, Error> {
    // iterate over multipart stream
    while let Some(item) = payload.next().await {
           let mut field = item?;

           // Field in turn is stream of *Bytes* object
           while let Some(chunk) = field.next().await {
               println!("-- CHUNK: \n{:?}", std::str::from_utf8(&chunk?));
           }
    }
    Ok(HttpResponse::Ok().into())
}

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Multipart, Error>>

Future that resolves to a Self.

type Config = ()

Configuration for this extractor.

fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

pub fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.

pub fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config, 

Create and configure config instance.

impl Stream for Multipart

type Item = Result<Field, MultipartError>

Values yielded by the stream.

fn poll_next(
    mut 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.

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

Returns the bounds on the remaining length of the stream.