Struct rocket::data::Data
[−]
[src]
pub struct Data { /* fields omitted */ }
Type representing the data in the body of an incoming request.
This type is the only means by which the body of a request can be retrieved.
This type is not usually used directly. Instead, types that implement
FromData are used via code generation by
specifying the data = "<param>"
route parameter as follows:
#[post("/submit", data = "<var>")] fn submit(var: T) -> ... { ... }
Above, T
can be any type that implements FromData
. Note that Data
itself implements FromData
.
Reading Data
Data may be read from a Data
object by calling either the
open or peek methods.
The open
method consumes the Data
object and returns the raw data
stream. The Data
object is consumed for safety reasons: consuming the
object ensures that holding a Data
object means that all of the data is
available for reading.
The peek
method returns a slice containing at most 4096 bytes of buffered
body data. This enables partially or fully reading from a Data
object
without consuming the Data
object.
Methods
impl Data
[src]
fn open(self) -> impl BufRead
Returns the raw data stream.
The stream contains all of the data in the body of the request,
including that in the peek
buffer. The method consumes the Data
instance. This ensures that a Data
type always represents all of
the data in a request.
fn peek(&self) -> &[u8]
Retrieve the peek
buffer.
The peek buffer contains at most 4096 bytes of the body of the request. The actual size of the returned buffer varies by web request. The peek_complete can be used to determine if this buffer contains all of the data in the body of the request.
fn peek_complete(&self) -> bool
Returns true if the peek
buffer contains all of the data in the body
of the request. Returns false
if it does not or if it is not known if
it does.
fn stream_to<W: Write>(self, writer: &mut W) -> Result<u64>
A helper method to write the body of the request to any Write
type.
This method is identical to io::copy(&mut data.open(), writer)
.
fn stream_to_file<P: AsRef<Path>>(self, path: P) -> Result<u64>
A helper method to write the body of the request to a file at the path
determined by path
.
This method is identical to
io::copy(&mut self.open(), &mut File::create(path)?)
.
Trait Implementations
impl Drop for Data
[src]
impl FromData for Data
[src]
The identity implementation of FromData
. Always returns Success
.