Skip to main content

StreamingMultipartField

Struct StreamingMultipartField 

Source
pub struct StreamingMultipartField<'a> { /* private fields */ }
Expand description

A single streaming field from a multipart form.

This field is one-shot: once you call chunk, bytes, text, or one of the save helpers, the underlying stream is consumed.

Implementations§

Source§

impl<'a> StreamingMultipartField<'a>

Source

pub fn name(&self) -> Option<&str>

Get the field name.

Source

pub fn file_name(&self) -> Option<&str>

Get the original filename when this field is a file upload.

Source

pub fn content_type(&self) -> Option<&str>

Get the content type of the field.

Source

pub fn is_file(&self) -> bool

Check whether this field represents a file upload.

Source

pub fn bytes_read(&self) -> usize

Number of bytes consumed from this field so far.

Source

pub async fn chunk(&mut self) -> Result<Option<Bytes>>

Read the next chunk from the field stream.

Source

pub async fn bytes(&mut self) -> Result<Bytes>

Collect the full field into memory.

Source

pub async fn text(&mut self) -> Result<String>

Collect the field as UTF-8 text.

Source

pub async fn save_to( &mut self, dir: impl AsRef<Path>, filename: Option<&str>, ) -> Result<String>

Save the field to a directory using either the provided filename or the uploaded name.

Source

pub async fn save_as(&mut self, path: impl AsRef<Path>) -> Result<()>

Save the field contents to an explicit file path without buffering the full file in memory.

Source

pub async fn into_uploaded_file(self) -> Result<UploadedFile>

Collect the field into an UploadedFile for APIs that still expect the buffered wrapper.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more