Struct multipart::server::Multipart
[−]
[src]
pub struct Multipart<R> { /* fields omitted */ }The server-side implementation of multipart/form-data requests.
Implements Borrow<R> to allow access to the request body, if desired.
Methods
impl Multipart<()>[src]
fn from_request<R: HttpRequest>(req: R) -> Result<Multipart<R::Body>, R>[src]
If the given HttpRequest is a multipart/form-data POST request,
return the request body wrapped in the multipart reader. Otherwise,
returns the original request.
impl<R: Read> Multipart<R>[src]
fn with_body<Bnd: Into<String>>(body: R, boundary: Bnd) -> Self[src]
Construct a new Multipart with the given body reader and boundary.
Note: boundary
This will prepend the requisite -- to the boundary string as documented in
IETF RFC 1341, Section 7.2.1: "Multipart: the common syntax".
Simply pass the value of the boundary key from the Content-Type header in the
request (or use Multipart::from_request(), if supported).
fn read_entry(&mut self) -> Result<Option<MultipartField<&mut Self>>>[src]
Read the next entry from this multipart request, returning a struct with the field's name and
data. See MultipartField for more info.
Warning: Risk of Data Loss
If the previously returned entry had contents of type MultipartField::File,
calling this again will discard any unread contents of that entry.
fn into_entry(self) -> ReadEntryResult<Self>[src]
Read the next entry from this multipart request, returning a struct with the field's name and
data. See MultipartField for more info.
fn foreach_entry<F>(&mut self, foreach: F) -> Result<()> where
F: FnMut(MultipartField<&mut Self>), [src]
F: FnMut(MultipartField<&mut Self>),
Call f for each entry in the multipart request.
This is a substitute for Rust not supporting streaming iterators (where the return value
from next() borrows the iterator for a bound lifetime).
Returns Ok(()) when all fields have been read, or the first error.
fn save(&mut self) -> SaveBuilder<&mut Self>[src]
Get a builder type for saving the files in this request to the filesystem.
See SaveBuilder for more information.
fn save_all(&mut self) -> EntriesSaveResult<&mut Self>[src]
: use .save().temp() instead
Read the request fully, parsing all fields and saving all files in a new temporary directory under the OS temporary directory.
If there is an error in reading the request, returns the partial result along with the
error. See SaveResult for more information.
fn save_all_under<P: AsRef<Path>>(
&mut self,
dir: P
) -> EntriesSaveResult<&mut Self>[src]
&mut self,
dir: P
) -> EntriesSaveResult<&mut Self>
: use .save().with_temp_dir() instead
Read the request fully, parsing all fields and saving all files in a new temporary
directory under dir.
If there is an error in reading the request, returns the partial result along with the
error. See SaveResult for more information.
fn save_all_limited(&mut self, limit: u64) -> EntriesSaveResult<&mut Self>[src]
: use .save().size_limit(limit) instead
Read the request fully, parsing all fields and saving all fields in a new temporary directory under the OS temporary directory.
Files larger than limit will be truncated to limit.
If there is an error in reading the request, returns the partial result along with the
error. See SaveResult for more information.
fn save_all_under_limited<P: AsRef<Path>>(
&mut self,
dir: P,
limit: u64
) -> EntriesSaveResult<&mut Self>[src]
&mut self,
dir: P,
limit: u64
) -> EntriesSaveResult<&mut Self>
: use .save().size_limit(limit).with_temp_dir() instead
Read the request fully, parsing all fields and saving all files in a new temporary
directory under dir.
Files larger than limit will be truncated to limit.
If there is an error in reading the request, returns the partial result along with the
error. See SaveResult for more information.