Struct FileData 

pub struct FileData { /* private fields */ }

Available on crate feature alloc only.

An owned file: its bytes, and the file name and content type the client sent, when they are text. The output of MemorySink and a field type for typed extraction from buffered bodies.

The bytes are wiped on drop. Debug prints the length only.

Examples

form_net::form! {
    pub struct Avatar {
        pub image: form_net::FileData,
    }
}
use form_net::FromForm;

let body = b"--X\r\nContent-Disposition: form-data; name=image; filename=\"me.png\"\r\nContent-Type: image/png\r\n\r\nPNG\r\n--X--";
let a = Avatar::from_multipart(b"multipart/form-data; boundary=X", body)?;
assert_eq!((a.image.bytes(), a.image.filename()), (&b"PNG"[..], Some("me.png")));

Implementations

impl FileData

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

The file’s bytes.

pub fn into_bytes(self) -> Vec<u8>

The file’s bytes, owned. They are no longer wiped by form-net.

pub fn len(&self) -> usize

The length in bytes.

pub fn is_empty(&self) -> bool

Whether the file is empty.

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

The client’s file name, as sent: never sanitized, never a path.

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

The declared content type: a hint, never trusted.

Trait Implementations

impl Debug for FileData

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

Formats the value using the given formatter.

impl Default for FileData

fn default() -> Self

Returns the “default value” for a type.

impl Drop for FileData

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 FileData

type Slot = Option<FileData>

What has arrived so far.

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

Takes one file.

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

The value, once every field has arrived.

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

Takes one text value.