pub struct Multipart<'r> { /* private fields */ }
Expand description
Represents the implementation of multipart/form-data
formatted data.
This will parse the source stream into Field
instances via
next_field()
.
Field Exclusivity
A Field
represents a raw, self-decoding stream into multipart data. As
such, only one Field
from a given Multipart
instance may be live at
once. That is, a Field
emitted by next_field()
must be dropped before
calling next_field()
again. Failure to do so will result in an error.
use std::convert::Infallible;
use bytes::Bytes;
use futures_util::stream::once;
use multer::Multipart;
let data = "--X-BOUNDARY\r\nContent-Disposition: form-data; \
name=\"my_text_field\"\r\n\r\nabcd\r\n--X-BOUNDARY--\r\n";
let stream = once(async move { Result::<Bytes, Infallible>::Ok(Bytes::from(data)) });
let mut multipart = Multipart::new(stream, "X-BOUNDARY");
let field1 = multipart.next_field().await;
let field2 = multipart.next_field().await;
assert!(field2.is_err());
Examples
use std::convert::Infallible;
use bytes::Bytes;
use futures_util::stream::once;
use multer::Multipart;
let data = "--X-BOUNDARY\r\nContent-Disposition: form-data; \
name=\"my_text_field\"\r\n\r\nabcd\r\n--X-BOUNDARY--\r\n";
let stream = once(async move { Result::<Bytes, Infallible>::Ok(Bytes::from(data)) });
let mut multipart = Multipart::new(stream, "X-BOUNDARY");
while let Some(field) = multipart.next_field().await.unwrap() {
println!("Field: {:?}", field.text().await)
}
Implementations
sourceimpl<'r> Multipart<'r>
impl<'r> Multipart<'r>
sourcepub fn new<S, O, E, B>(stream: S, boundary: B) -> Multipart<'r> where
S: 'r + Stream<Item = Result<O, E>> + Send,
O: 'static + Into<Bytes>,
E: 'r + Into<Box<dyn Error + Sync + Send + 'static, Global>>,
B: Into<String>,
pub fn new<S, O, E, B>(stream: S, boundary: B) -> Multipart<'r> where
S: 'r + Stream<Item = Result<O, E>> + Send,
O: 'static + Into<Bytes>,
E: 'r + Into<Box<dyn Error + Sync + Send + 'static, Global>>,
B: Into<String>,
Construct a new Multipart
instance with the given [Bytes
] stream and
the boundary.
sourcepub fn with_constraints<S, O, E, B>(
stream: S,
boundary: B,
constraints: Constraints
) -> Multipart<'r> where
S: 'r + Stream<Item = Result<O, E>> + Send,
O: 'static + Into<Bytes>,
E: 'r + Into<Box<dyn Error + Sync + Send + 'static, Global>>,
B: Into<String>,
pub fn with_constraints<S, O, E, B>(
stream: S,
boundary: B,
constraints: Constraints
) -> Multipart<'r> where
S: 'r + Stream<Item = Result<O, E>> + Send,
O: 'static + Into<Bytes>,
E: 'r + Into<Box<dyn Error + Sync + Send + 'static, Global>>,
B: Into<String>,
Construct a new Multipart
instance with the given [Bytes
] stream and
the boundary.
sourcepub async fn next_field(&'_ mut self) -> Result<Option<Field<'r>>, Error>
pub async fn next_field(&'_ mut self) -> Result<Option<Field<'r>>, Error>
Yields the next Field
if available.
Any previous Field
returned by this method must be dropped before
calling this method or Multipart::next_field_with_idx()
again. See
field-exclusivity for details.
sourcepub async fn next_field_with_idx(
&'_ mut self
) -> Result<Option<(usize, Field<'r>)>, Error>
pub async fn next_field_with_idx(
&'_ mut self
) -> Result<Option<(usize, Field<'r>)>, Error>
Yields the next Field
with their positioning index as a tuple
(
usize
,
Field
)
.
Any previous Field
returned by this method must be dropped before
calling this method or Multipart::next_field()
again. See
field-exclusivity for details.
Examples
use std::convert::Infallible;
use bytes::Bytes;
use futures_util::stream::once;
use multer::Multipart;
let data = "--X-BOUNDARY\r\nContent-Disposition: form-data; \
name=\"my_text_field\"\r\n\r\nabcd\r\n--X-BOUNDARY--\r\n";
let stream = once(async move { Result::<Bytes, Infallible>::Ok(Bytes::from(data)) });
let mut multipart = Multipart::new(stream, "X-BOUNDARY");
while let Some((idx, field)) = multipart.next_field_with_idx().await.unwrap() {
println!("Index: {:?}, Content: {:?}", idx, field.text().await)
}
Trait Implementations
Auto Trait Implementations
impl<'r> !RefUnwindSafe for Multipart<'r>
impl<'r> Send for Multipart<'r>
impl<'r> Sync for Multipart<'r>
impl<'r> Unpin for Multipart<'r>
impl<'r> !UnwindSafe for Multipart<'r>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more