Struct MultipartFile 

pub struct MultipartFile<M> {
    pub filename: Option<String>,
    pub content_type: Mime,
    /* private fields */
}

A representation of a file in HTTP multipart/form-data.

Note that the file is not yet saved to the local filesystem; instead, this struct exposes Read and BufRead impls which point to the beginning of the file’s contents in the HTTP stream.

You can read it to EOF, or use one of the save() method to save it to disk.

Fields

filename: Option<String>

The filename of this entry, if supplied.

Warning: Client Provided / Untrustworthy

You should treat this value as untrustworthy because it is an arbitrary string provided by the client.

It is a serious security risk to create files or directories with paths based on user input. A malicious user could craft a path which can be used to overwrite important files, such as web templates, static assets, Javascript files, database files, configuration files, etc., if they are writable by the server process.

This can be mitigated somewhat by setting filesystem permissions as conservatively as possible and running the server under its own user with restricted permissions, but you should still not use user input directly as filesystem paths. If it is truly necessary, you should sanitize filenames such that they cannot be misinterpreted by the OS. Such functionality is outside the scope of this crate.

content_type: Mime

The MIME type (Content-Type value) of this file, if supplied by the client, or "applicaton/octet-stream" otherwise.

Note: Client Provided

Consider this value to be potentially untrustworthy, as it is provided by the client. It may be inaccurate or entirely wrong, depending on how the client determined it.

Some variants wrap arbitrary strings which could be abused by a malicious user if your application performs any non-idempotent operations based on their value, such as starting another program or querying/updating a database (web-search “SQL injection”).

Implementations

impl<M> MultipartFile<M>

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

👎Deprecated since 0.10.0: filename field is now public

Get the filename of this entry, if supplied.

Warning: Client Provided / Untrustworthy

You should treat this value as untrustworthy because it is an arbitrary string provided by the client.

It is a serious security risk to create files or directories with paths based on user input. A malicious user could craft a path which can be used to overwrite important files, such as web templates, static assets, Javascript files, database files, configuration files, etc., if they are writable by the server process.

This can be mitigated somewhat by setting filesystem permissions as conservatively as possible and running the server under its own user with restricted permissions, but you should still not use user input directly as filesystem paths. If it is truly necessary, you should sanitize filenames such that they cannot be misinterpreted by the OS. Such functionality is outside the scope of this crate.

pub fn content_type(&self) -> &Mime

👎Deprecated since 0.10.0: content_type field is now public

Get the MIME type (Content-Type value) of this file, if supplied by the client, or "applicaton/octet-stream" otherwise.

Note: Client Provided

Consider this value to be potentially untrustworthy, as it is provided by the client. It may be inaccurate or entirely wrong, depending on how the client determined it.

Some variants wrap arbitrary strings which could be abused by a malicious user if your application performs any non-idempotent operations based on their value, such as starting another program or querying/updating a database (web-search “SQL injection”).

impl<M> MultipartFile<M>

where M: ReadEntry,

pub fn save(&mut self) -> SaveBuilder<&mut MultipartFile<M>>

Get a builder type which can save the file with or without a size limit.

pub fn save_to<W>(&mut self, out: W) -> Result<u64, Error>

where W: Write,

👎Deprecated since 0.10.0: use .save().write_to() instead

Save this file to the given output stream.

If successful, returns the number of bytes written.

Retries when io::Error::kind() == io::ErrorKind::Interrupted.

pub fn save_to_limited<W>(&mut self, out: W, limit: u64) -> Result<u64, Error>

where W: Write,

👎Deprecated since 0.10.0: use .save().size_limit(limit).write_to(out) instead

Save this file to the given output stream, truncated to limit (no more than limit bytes will be written out).

If successful, returns the number of bytes written.

Retries when io::Error::kind() == io::ErrorKind::Interrupted.

pub fn save_as<P>(&mut self, path: P) -> Result<SavedFile, Error>

where P: Into<PathBuf>,

👎Deprecated since 0.10.0: use .save().with_path(path) instead

Save this file to path.

Returns the saved file info on success, or any errors otherwise.

Retries when io::Error::kind() == io::ErrorKind::Interrupted.

pub fn save_in<P>(&mut self, dir: P) -> Result<SavedFile, Error>

where P: AsRef<Path>,

👎Deprecated since 0.10.0: use .save().with_dir(dir) instead

Save this file in the directory pointed at by dir, using a random alphanumeric string as the filename.

Any missing directories in the dir path will be created.

Returns the saved file’s info on success, or any errors otherwise.

Retries when io::Error::kind() == io::ErrorKind::Interrupted.

pub fn save_as_limited<P>( &mut self, path: P, limit: u64, ) -> Result<SavedFile, Error>

where P: Into<PathBuf>,

👎Deprecated since 0.10.0: use .save().size_limit(limit).with_path(path) instead

Save this file to path, truncated to limit (no more than limit bytes will be written out).

Any missing directories in the dir path will be created.

Returns the saved file’s info on success, or any errors otherwise.

Retries when io::Error::kind() == io::ErrorKind::Interrupted.

pub fn save_in_limited<P>( &mut self, dir: P, limit: u64, ) -> Result<SavedFile, Error>

where P: AsRef<Path>,

👎Deprecated since 0.10.0: use .save().size_limit(limit).with_dir(dir) instead

Save this file in the directory pointed at by dir, using a random alphanumeric string as the filename.

Truncates file to limit (no more than limit bytes will be written out).

Any missing directories in the dir path will be created.

Returns the saved file’s info on success, or any errors otherwise.

Retries when io::Error::kind() == io::ErrorKind::Interrupted.

Trait Implementations

impl<M> BufRead for MultipartFile<M>

where M: ReadEntry,

fn fill_buf(&mut self) -> Result<&[u8], Error>

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.

fn consume(&mut self, amt: usize)

Marks the given amount of additional bytes from the internal buffer as having been read. Subsequent calls to read only return bytes that have not been marked as read.

fn has_data_left(&mut self) -> Result<bool, Error>

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

Checks if there is any data left to be read.

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<M> Debug for MultipartFile<M>

where M: Debug,

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

Formats the value using the given formatter.

impl<M> Read for MultipartFile<M>

where M: ReadEntry,

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.