Skip to main content

FormFileBuilder

Struct FormFileBuilder 

Source
pub struct FormFileBuilder { /* private fields */ }
Expand description

Incrementally builds a FormFile while a multipart part streams in.

The builder buffers in memory up to memory_threshold bytes and spills to a temporary file beyond that, so peak memory per upload is bounded regardless of file size.

Implementations§

Source§

impl FormFileBuilder

Source

pub fn new( field_name: impl Into<String>, raw_file_name: impl Into<String>, content_type: Option<String>, ) -> FormFileBuilder

Start building a file for field_name.

raw_file_name is the client-supplied name; it is sanitised by sanitize_file_name when the file is finished.

Source

pub fn memory_threshold(self, bytes: usize) -> FormFileBuilder

Bytes kept in memory before spilling to disk. Default: 1 MiB.

Source

pub fn max_size(self, bytes: u64) -> FormFileBuilder

Maximum accepted size for this file. Default: 128 MiB.

Exceeding it fails the upload with Error::PayloadTooLarge.

Source

pub fn spool_dir(self, dir: impl Into<PathBuf>) -> FormFileBuilder

Directory used for spooled files. Default: spool_root.

Source

pub async fn write(&mut self, chunk: &[u8]) -> Result<(), Error>

Append a chunk of the current part.

Returns Error::PayloadTooLarge as soon as the file exceeds FormFileBuilder::max_size, so an oversized upload is rejected without buffering the whole body.

Source

pub async fn finish(self) -> Result<FormFile, Error>

Finish the part and produce the FormFile.

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> IClaimsCarrier for T
where T: Send,

Source§

fn set_claims(&mut self, _claims: Option<Box<dyn IClaims>>)

Default no-op. Overridden by inherent set_claims on types that carry claims.
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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