Struct Store 

pub struct Store { /* private fields */ }

Available on crate feature fs only.

Where uploads are kept. Send + Sync; create one per process or per route and share it by reference.

Examples

use form_net::{SpillMode, Store};

// Files over 64 KiB spill to anonymous temporary files.
let store = Store::temp()?;
assert!(store.dir().is_some());

// Never touch the file system.
let memory = Store::memory_only().memory_threshold(1 << 20);
assert!(memory.dir().is_none());

Implementations

impl Store

pub fn temp() -> Result<Store, FormError>

A store with its own private directory under the system temporary directory, created now: form-net-<32 hex>, owner-only on Unix, failing if the path exists. Files up to 64 KiB stay in memory; larger ones spill to anonymous temporary files.

Errors

Io { kind } when the directory cannot be created; Random when the OS random source fails (no predictable fallback name).

pub fn memory_only() -> Store

A store that never touches the file system: a file larger than max_file_bytes is refused, never spilled.

pub fn in_dir(dir: impl AsRef<Path>) -> Result<Store, FormError>

A store that spills into dir, a directory the caller made. It must exist and be a directory, not a link to one.

Errors

Store { NotADirectory }; Io { kind }.

Examples

let dir = std::env::temp_dir();
let store = form_net::Store::in_dir(&dir)?;
assert_eq!(store.dir(), Some(dir.as_path()));

pub fn memory_threshold(self, bytes: u64) -> Store

Keeps each file in memory up to bytes; a file whose next write would pass it spills first. 0 spills every file at its first byte.

pub fn max_disk_bytes(self, bytes: u64) -> Store

Caps the bytes one request may put on disk (Limit { Disk } beyond). Unset, the cap is the request’s max_body_bytes.

pub fn mode(self, mode: SpillMode) -> Store

How spilled files are kept.

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

The directory files spill into, once it exists.

pub fn cleanup_failures(&self) -> u64

Deletions that failed during a drop (they cannot be returned).

pub fn stats(&self) -> StoreStats

What the store holds now.

pub fn sink(&self, limits: &Limits) -> StoreSink

The Sink that stores the files of one request under limits.

Trait Implementations

impl Clone for Store

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Store

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

Formats the value using the given formatter.