Struct Form 

pub struct Form { /* private fields */ }

A builder for a multipart/form-data request body.

Add fields via Part, then obtain the Content-Type header value with Form::content_type and the body stream with [Form::into_stream].

Examples

use http::Request;
use http_multipart::{Form, Part};

// construct a form from parts
let parts = vec![
    Part::text("username", "alice"),
    Part::binary("data", &b"hello"[..]).file_name("hello.bin"),
];
let form = Form::new(parts);

// build a request with the form
let req = Request::builder()
    .method("POST") // multipart is usually used with POST method
    .header("Content-Type", form.content_type()) // content type header must be set to form's content type
    .body(form) // form implements Stream, so it can be used directly as the body
    .unwrap();

Implementations

impl Form

pub fn new(parts: Vec<Part>) -> Self

Create a new form with an automatically generated boundary.

pub fn with_boundary( boundary: impl AsRef<[u8]>, parts: Vec<Part>, ) -> Result<Self, MultipartError>

Create a form with a caller-supplied boundary.

Returns MultipartError::Boundary if boundary is empty or contains \r / \n (which would break the wire format).

pub fn boundary(&self) -> &[u8]

The raw boundary bytes used by this form.

pub fn content_type(&self) -> HeaderValue

The Content-Type header value that must be set on the outgoing request.

Example: multipart/form-data; boundary=0000000000001a2b

Trait Implementations

impl Stream for Form

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.