Struct Form 

pub struct Form { /* private fields */ }

Available on non-WebAssembly and crate feature multipart only.

An async multipart/form-data request.

Implementations

impl Form

pub fn new() -> Form

Creates a new async Form without any content.

pub fn boundary(&self) -> &str

Get the boundary that this form will use.

pub fn set_boundary(&mut self, boundary: impl Into<String>)

Set the boundary that this form will use. By default the boundary is a long random string to minimize the risk of the boundary appearing in the body content.

Setting a custom boundary incurs significant risk of generating corrupted bodies. Only use this if you need it and you understand the risk!

pub fn text<T, U>(self, name: T, value: U) -> Form

where T: Into<Cow<'static, str>>, U: Into<Cow<'static, str>>,

Add a data field with supplied name and value.

Examples

let form = reqwest::multipart::Form::new()
    .text("username", "seanmonstar")
    .text("password", "secret");

pub async fn file<T, U>(self, name: T, path: U) -> Result<Form>

where T: Into<Cow<'static, str>>, U: AsRef<Path>,

Available on crate feature stream only.

Adds a file field.

The path will be used to try to guess the filename and mime.

Examples

let form = reqwest::multipart::Form::new()
    .file("key", "/path/to/file").await?;

Errors

Errors when the file cannot be opened.

pub fn part<T>(self, name: T, part: Part) -> Form

where T: Into<Cow<'static, str>>,

Adds a customized Part.

pub fn percent_encode_path_segment(self) -> Form

Configure this Form to percent-encode using the path-segment rules.

pub fn percent_encode_attr_chars(self) -> Form

Configure this Form to percent-encode using the attr-char rules.

pub fn percent_encode_noop(self) -> Form

Configure this Form to skip percent-encoding

pub fn into_stream( self, ) -> impl Stream<Item = Result<Bytes, Error>> + Send + Sync

Produce a stream of the bytes in this Form, consuming it.

Trait Implementations

impl Debug for Form

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

Formats the value using the given formatter.

impl Default for Form

fn default() -> Self

Returns the “default value” for a type.