Struct mpart_async::client::MultipartRequest

pub struct MultipartRequest<S> { /* private fields */ }

The main MultipartRequest struct for sending Multipart submissions to servers

Implementations

impl<E, S> MultipartRequest<S> where
    S: Stream<Item = Result<Bytes, E>> + Unpin, 

pub fn new<I: Into<String>>(boundary: I) -> Self

Construct a new MultipartRequest with a given Boundary

If you want a boundary generated automatically, then you can use MultipartRequest::default()

pub fn add_stream<I: Into<String>>(
    &mut self,
    name: I,
    filename: I,
    content_type: I,
    stream: S
)

Add a raw Stream to the Multipart request

The Stream should return items of Result<Bytes, Error>

pub fn add_field<I: Into<String>>(&mut self, name: I, value: I)

Add a Field to the Multipart request

pub fn get_boundary(&self) -> &str

Gets the boundary for the MultipartRequest

This is useful for supplying the Content-Type header

impl MultipartRequest<FileStream>

pub fn add_file<I: Into<String>, P: Into<PathBuf>>(&mut self, name: I, path: P)

Add a FileStream to a MultipartRequest given a path to a file

This will guess the Content Type based upon the path (i.e, .jpg will be image/jpeg)

Trait Implementations

impl<E, S> Default for MultipartRequest<S> where
    S: Stream<Item = Result<Bytes, E>> + Unpin, 

fn default() -> Self

Returns the “default value” for a type.

impl<E, S: Stream> Stream for MultipartRequest<S> where
    S: Stream<Item = Result<Bytes, E>> + Unpin, 

type Item = Result<Bytes, E>

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.