Struct StoredFile 

pub struct StoredFile { /* private fields */ }

Available on crate feature fs only.

One received file, in memory or in a temporary file.

Dropping it without persist deletes it (closing the handle first) and wipes memory-held bytes. Debug never prints the file name or the data.

Examples

use std::io::Read;

let body = b"--X\r\nContent-Disposition: form-data; name=doc; filename=a.txt\r\n\r\nhello\r\n--X--";
let upload = form_net::read_multipart(b"multipart/form-data; boundary=X", &body[..])?;
let file = upload.file("doc").unwrap();
let mut text = String::new();
file.reader()?.read_to_string(&mut text).unwrap();
assert_eq!((text.as_str(), file.len(), file.is_in_memory()), ("hello", 5, true));

Implementations

impl StoredFile

pub fn name(&self) -> &str

The form field name.

pub fn filename(&self) -> Option<FileName<'_>>

The client’s file name: a hint, never a path.

pub fn content_type(&self) -> Option<ContentType<'_>>

The declared content type: a hint, never trusted.

pub const fn len(&self) -> u64

The length in bytes.

pub const fn is_empty(&self) -> bool

Whether the file is empty.

pub const fn is_in_memory(&self) -> bool

Whether the file is held in memory.

pub fn bytes(&self) -> Option<&[u8]>

The bytes, while the file is in memory.

pub fn reader(&self) -> Result<StoredReader<'_>, FormError>

A reader over the file, in memory or on disk. It reads with positional reads, so several readers can exist at once.

Errors

Io { kind } when the file is gone.

pub fn read_to_vec(&self, max: u64) -> Result<Vec<u8>, FormError>

The whole file in a new vector, refusing a file longer than max before allocating.

Errors

Limit { FileSize }; Io { kind }.

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

The temporary file’s path, in SpillMode::Named only.

pub fn persist(self, dest: &Path) -> Result<(), FormError>

Moves the finished upload to dest, which the caller built. It never overwrites: a named file is hard-linked when dest is on the same file system and copied otherwise; anonymous and memory files are copied into dest opened with create_new. Whether to fsync dest and its directory is the caller’s choice. On error the temporary file is deleted like any dropped file.

Errors

Store { DestinationExists }; Io { kind }.

Trait Implementations

impl Debug for StoredFile

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

Formats the value using the given formatter.

impl Drop for StoredFile

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl FromField for StoredFile

type Slot = Option<StoredFile>

Available on crate feature alloc only.

What has arrived so far.

fn accept_file( slot: &mut Self::Slot, file: FileValue<'_>, ) -> Result<(), ValueError>

Available on crate feature alloc only.

Takes one file.

fn finish(slot: Self::Slot) -> Result<Self, ValueError>

Available on crate feature alloc only.

The value, once every field has arrived.

fn accept_text(slot: &mut Self::Slot, value: &str) -> Result<(), ValueError>

Available on crate feature alloc only.

Takes one text value.