Struct FormFile 

pub struct FormFile { /* private fields */ }

One file part of a multipart/form-data request.

Cloning a FormFile is cheap: all clones share the same underlying bytes or spooled temporary file, and the temporary file is removed when the last clone is dropped.

Implementations

impl FormFile

pub fn field_name(&self) -> &str

The form field name this file arrived under (e.g. "avatar").

pub fn file_name(&self) -> &str

A filesystem-safe basename derived from the client-supplied filename.

Path separators, control characters and Windows-reserved characters are removed, so this is safe to pass to Path::join. Use FormFile::original_file_name if you need the raw value for display.

pub fn original_file_name(&self) -> &str

The filename exactly as sent by the client, without sanitisation.

Never use this to build a filesystem path.

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

The part’s declared content type, if the client sent one.

This is attacker-controlled metadata: treat it as a hint, not a guarantee.

pub fn size(&self) -> u64

Size of the uploaded content in bytes.

pub fn is_empty(&self) -> bool

Whether the uploaded content is empty.

pub fn extension(&self) -> Option<String>

Lowercase file extension of FormFile::file_name, without the dot.

pub fn path(&self) -> Option<&Path>

The spooled temporary file path, when the upload was large enough to be written to disk.

The path is only valid while this FormFile (or a clone) is alive. Prefer FormFile::save_as to hand a file to the rest of your application.

pub async fn open(&self) -> Result<Box<dyn AsyncRead + Unpin + Send>, Error>

Open the uploaded content as an async reader.

Memory-backed files read from a reference-counted buffer without copying it; spooled files are opened from disk. Either way the read is streamed.

pub async fn read_bytes(&self) -> Result<Vec<u8>, Error>

Read the whole upload into memory.

Prefer FormFile::open or FormFile::copy_to for files that may be large.

pub async fn copy_to<W>(&self, writer: &mut W) -> Result<u64, Error>

where W: AsyncWrite + Unpin + ?Sized,

Stream the upload into writer, returning the number of bytes written.

Uses the framework’s 64 KiB copy buffer rather than the 8 KiB default, which matters when a multi-gigabyte upload is being persisted.

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

Stream the upload to destination, creating parent directories.

The bytes are written to a sibling temporary file first and renamed into place, so destination never contains a partially written upload.

Trait Implementations

impl Clone for FormFile

fn clone(&self) -> FormFile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FormFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.