Struct StoreSink 

pub struct StoreSink { /* private fields */ }

Available on crate feature fs only.

The Sink a Store hands out for one request.

Examples

use form_net::{Boundary, Driver, Limits, MultipartParser, NoInspector, Policy, Progress, Store};

let store = Store::memory_only();
let parser = MultipartParser::new(Boundary::new(b"X")?, &Limits::DEFAULT, &Policy::DEFAULT)?;
let mut driver = Driver::new(parser, store.sink(&Limits::DEFAULT));
let body = b"--X\r\nContent-Disposition: form-data; name=f; filename=a.txt\r\n\r\nhello\r\n--X--";
let (_, progress) = driver.push(body, true, &mut NoInspector)?;
// The sink's output is a `StoredFile`, counted by the store.
assert!(matches!(progress, Progress::File(ref f) if f.name() == "f"));
assert_eq!(store.stats().files_in_memory, 1);

Trait Implementations

impl Debug for StoreSink

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

Formats the value using the given formatter.

impl Drop for StoreSink

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 Sink for StoreSink

type Output = StoredFile

What a closed part becomes.

fn open(&mut self, head: &PartHead<'_>) -> Result<(), FormError>

A file part starts.

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

More bytes of the current file part.

fn close(&mut self) -> Result<StoredFile, FormError>

The current file part ended.

fn abort(&mut self)

Discards the current file part, if any, and releases everything.