pub struct Data<'r> { /* private fields */ }
Expand description
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§
source§impl<'r> Data<'r>
impl<'r> Data<'r>
sourcepub fn open(self, limit: ByteUnit) -> DataStream<'r>
pub fn open(self, limit: ByteUnit) -> DataStream<'r>
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());
}
sourcepub async fn peek(&mut self, num: usize) -> &[u8] ⓘ
pub async fn peek(&mut self, num: usize) -> &[u8] ⓘ
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 min
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::{Data, FromData, Outcome};
use rocket::http::Status;
#[rocket::async_trait]
impl<'r> FromData<'r> for MyType {
type Error = MyError;
async fn from_data(r: &'r Request<'_>, mut data: Data<'r>) -> Outcome<'r, Self> {
if data.peek(2).await != b"hi" {
return Outcome::Forward((data, Status::NotFound))
}
/* .. */
}
}
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"` */
}
/* .. */
}
}
sourcepub fn peek_complete(&self) -> bool
pub 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.
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§
source§impl<'r> FromData<'r> for Data<'r>
impl<'r> FromData<'r> for Data<'r>
§type Error = Infallible
type Error = Infallible
source§fn from_data<'life0, 'async_trait>(
_: &'r Request<'life0>,
data: Data<'r>
) -> Pin<Box<dyn Future<Output = Outcome<'r, Self>> + Send + 'async_trait>>where
Self: 'async_trait,
'r: 'async_trait,
'life0: 'async_trait,
fn from_data<'life0, 'async_trait>( _: &'r Request<'life0>, data: Data<'r> ) -> Pin<Box<dyn Future<Output = Outcome<'r, Self>> + Send + 'async_trait>>where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait,
Self
from the incoming request body data. Read moreAuto Trait Implementations§
impl<'r> !RefUnwindSafe for Data<'r>
impl<'r> Send for Data<'r>
impl<'r> Sync for Data<'r>
impl<'r> Unpin for Data<'r>
impl<'r> !UnwindSafe for Data<'r>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere T: ?Sized,
source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
Example
println!("{}", value.bright_yellow());
source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
Example
println!("{}", value.bright_magenta());
source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
Example
println!("{}", value.on_bright_black());
source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
Example
println!("{}", value.on_bright_white());
source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
Example
println!("{}", value.rapid_blink());
source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);