Struct Part 

pub struct Part { /* private fields */ }

Available on crate features client and multipart only.

A single field of a Form.

A Part can be created from in-memory bytes/text (Part::text, Part::bytes), an arbitrary async reader (Part::reader, the counterpart of SetFileReader), or a file path (Part::file). Additional metadata such as filename and Content-Type can be attached with Part::file_name and Part::mime_str/Part::mime.

Implementations

impl Part

pub fn text<T>(value: T) -> Self

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

Create a text Part from a UTF-8 string.

pub fn bytes<T>(value: T) -> Self

where T: Into<Bytes>,

Create a Part from in-memory bytes.

pub fn reader<R>(reader: R) -> Self

where R: AsyncRead + Send + Sync + 'static,

Create a Part from an arbitrary AsyncRead reader, whose content is streamed lazily.

This is the counterpart of SetFileReader: any reader (a file, a socket, a pipe, …) can be used as the source of a part without buffering the whole content in memory.

pub async fn file<P>(path: P) -> Result<Self>

where P: AsRef<Path>,

Create a Part from a file path, whose content is streamed lazily.

The filename defaults to the file name of the path, and the Content-Type is guessed from the file extension. Both can be overridden by Part::file_name and Part::mime_str/Part::mime.

pub fn file_name<T>(self, file_name: T) -> Self

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

Set the filename of the part.

pub fn mime_str(self, mime: &str) -> Result<Self, FromStrError>

Set the Content-Type of the part from a string.

Errors

Returns an error if the given string is not a valid MIME type.

pub fn mime(self, mime: Mime) -> Self

Set the Content-Type of the part.