Struct rocket::Data [−][src]
Type representing the body data of a 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, data guards (types that
implement FromData
) are created indirectly via
code generation by specifying the data = "<var>"
route parameter as
follows:
#[post("/submit", data = "<var>")] fn submit(var: DataGuard) { /* ... */ }
Above, DataGuard
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 512 bytes of buffered
body data. This enables partially or fully reading from a Data
object
without consuming the Data
object.
Implementations
impl Data
[src]
pub fn open(self, limit: ByteUnit) -> DataStream
[src]
Returns the raw data stream, limited to limit
bytes.
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.
Example
use rocket::data::{Data, ToByteUnit}; fn handler(data: Data) { let stream = data.open(2.mebibytes()); }
pub async fn peek(&mut self, num: usize) -> &[u8]
[src]
Retrieve at most num
bytes from the peek
buffer without consuming
self
.
The peek buffer contains at most 512 bytes of the body of the request.
The actual size of the returned buffer is the max
of the request’s
body, num
and 512
. The peek_complete
method can be used to determine if this buffer contains all of the
data in the body of the request.
Examples
In a data guard:
use rocket::request::{self, Request, FromRequest}; use rocket::data::{self, Data, FromData}; #[rocket::async_trait] impl<'r> FromData<'r> for MyType { type Error = MyError; async fn from_data( req: &'r Request<'_>, mut data: Data ) -> data::Outcome<Self, Self::Error> { if data.peek(2).await != b"hi" { return data::Outcome::Forward(data) } /* .. */ } }
In a fairing:
use rocket::{Rocket, Request, Data, Response}; use rocket::fairing::{Fairing, Info, Kind}; #[rocket::async_trait] impl Fairing for MyType { fn info(&self) -> Info { Info { name: "Data Peeker", kind: Kind::Request } } async fn on_request(&self, req: &mut Request<'_>, data: &mut Data) { if data.peek(2).await == b"hi" { /* do something; body data starts with `"hi"` */ } /* .. */ } }
pub fn peek_complete(&self) -> bool
[src]
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.
Example
use rocket::data::Data; async fn handler(mut data: Data) { if data.peek_complete() { println!("All of the data: {:?}", data.peek(512).await); } }
Trait Implementations
impl<'r> FromData<'r> for Data
[src]
type Error = Infallible
The associated error to be returned when the guard fails.
fn from_data<'life0, 'async_trait>(
__arg0: &'r Request<'life0>,
data: Data
) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>> where
'r: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,
[src]
__arg0: &'r Request<'life0>,
data: Data
) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>> where
'r: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,
impl<S, E> IntoOutcome<S, (Status, E), Data> for Result<S, E>
[src]
Auto Trait Implementations
impl !RefUnwindSafe for Data
impl Send for Data
impl Sync for Data
impl Unpin for Data
impl !UnwindSafe for Data
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> IntoCollection<T> for T
pub fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
A: Array<Item = T>,
pub fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
F: FnMut(T) -> U,
A: Array<Item = U>,
F: FnMut(T) -> U,
A: Array<Item = U>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,