Struct multipart::server::MultipartFile

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

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").

Methods

impl<M> MultipartFile<M>

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.

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, 

fn save(&mut self) -> SaveBuilder<&mut Self>

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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: Debug> Debug for MultipartFile<M>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<M: ReadEntry> Read for MultipartFile<M>

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

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

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chars(self) -> Chars<Self>

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<M: ReadEntry> BufRead for MultipartFile<M>

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

Fills the internal buffer of this object, returning the buffer contents.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

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

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

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

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

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

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

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.