pub struct Limits { /* private fields */ }
Expand description
Mapping from (hierarchical) data types to size limits.
A Limits
structure contains a mapping from a given hierarchical data type
(“form”, “data-form”, “ext/pdf”, and so on) to the maximum size in bytes
that should be accepted by Rocket for said data type. For instance, if the
limit for “form” is set to 256
, only 256 bytes from an incoming non-data
form (that is, url-encoded) will be accepted.
To help in preventing DoS attacks, all incoming data reads must capped by a
limit. As such, all data guards impose a limit. The name of the limit is
dictated by the data guard or type itself. For instance, Form
imposes
the form
limit for value-based forms and data-form
limit for data-based
forms.
If a limit is exceeded, a guard will typically fail. The Capped
type
allows retrieving some data types even when the limit is exceeded.
Hierarchy
Data limits are hierarchical. The /
(forward slash) character delimits the
levels, or layers, of a given limit. To obtain a limit value for a given
name, layers are peeled from right to left until a match is found, if any.
For example, fetching the limit named pet/dog/bingo
will return the first
of pet/dog/bingo
, pet/dog
or pet
:
use rocket::data::{Limits, ToByteUnit};
let limits = Limits::default()
.limit("pet", 64.kibibytes())
.limit("pet/dog", 128.kibibytes())
.limit("pet/dog/bingo", 96.kibibytes());
assert_eq!(limits.get("pet/dog/bingo"), Some(96.kibibytes()));
assert_eq!(limits.get("pet/dog/ralph"), Some(128.kibibytes()));
assert_eq!(limits.get("pet/cat/bingo"), Some(64.kibibytes()));
assert_eq!(limits.get("pet/dog/bingo/hat"), Some(96.kibibytes()));
Built-in Limits
The following table details recognized built-in limits used by Rocket.
Limit Name | Default | Type | Description |
---|---|---|---|
form | 32KiB | Form | entire non-data-based form |
data-form | 2MiB | Form | entire data-based form |
file | 1MiB | TempFile | TempFile data guard or form field |
file/$ext | N/A | TempFile | file form field with extension $ext |
string | 8KiB | String | data guard or data form field |
bytes | 8KiB | Vec<u8> | data guard |
json | 1MiB | Json | JSON data and form payloads |
msgpack | 1MiB | MsgPack | MessagePack data and form payloads |
Usage
A Limits
structure is created following the builder pattern:
use rocket::data::{Limits, ToByteUnit};
// Set a limit of 64KiB for forms, 3MiB for PDFs, and 1MiB for JSON.
let limits = Limits::default()
.limit("form", 64.kibibytes())
.limit("file/pdf", 3.mebibytes())
.limit("json", 2.mebibytes());
The Limits::default()
method populates the Limits
structure with default limits in the table above. A
configured limit can be retrieved via the &Limits
request guard:
use std::io;
use rocket::data::{Data, Limits, ToByteUnit};
#[post("/echo", data = "<data>")]
async fn echo(data: Data<'_>, limits: &Limits) -> io::Result<String> {
let limit = limits.get("data").unwrap_or(1.mebibytes());
Ok(data.open(limit).into_string().await?.value)
}
…or via the Request::limits()
method:
use rocket::request::Request;
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<'_>, data: Data<'r>) -> data::Outcome<'r, Self> {
let limit = req.limits().get("my-data-type");
/* .. */
}
}
Implementations§
source§impl Limits
impl Limits
sourcepub const MESSAGE_PACK: ByteUnit = _
pub const MESSAGE_PACK: ByteUnit = _
Default limit for MessagePack payloads.
sourcepub fn new() -> Self
pub fn new() -> Self
Construct a new Limits
structure with no limits set.
Example
use rocket::data::{Limits, ToByteUnit};
let limits = Limits::default();
assert_eq!(limits.get("form"), Some(32.kibibytes()));
let limits = Limits::new();
assert_eq!(limits.get("form"), None);
sourcepub fn limit<S: Into<Uncased<'static>>>(self, name: S, limit: ByteUnit) -> Self
pub fn limit<S: Into<Uncased<'static>>>(self, name: S, limit: ByteUnit) -> Self
Adds or replaces a limit in self
, consuming self
and returning a new
Limits
structure with the added or replaced limit.
Example
use rocket::data::{Limits, ToByteUnit};
let limits = Limits::default();
assert_eq!(limits.get("form"), Some(32.kibibytes()));
assert_eq!(limits.get("json"), Some(1.mebibytes()));
assert_eq!(limits.get("cat"), None);
let limits = limits.limit("cat", 1.mebibytes());
assert_eq!(limits.get("form"), Some(32.kibibytes()));
assert_eq!(limits.get("cat"), Some(1.mebibytes()));
let limits = limits.limit("json", 64.mebibytes());
assert_eq!(limits.get("json"), Some(64.mebibytes()));
sourcepub fn get<S: AsRef<str>>(&self, name: S) -> Option<ByteUnit>
pub fn get<S: AsRef<str>>(&self, name: S) -> Option<ByteUnit>
Returns the limit named name
, proceeding hierarchically from right
to left until one is found, or returning None
if none is found.
Example
use rocket::data::{Limits, ToByteUnit};
let limits = Limits::default()
.limit("json", 2.mebibytes())
.limit("file/jpeg", 4.mebibytes())
.limit("file/jpeg/special", 8.mebibytes());
assert_eq!(limits.get("form"), Some(32.kibibytes()));
assert_eq!(limits.get("json"), Some(2.mebibytes()));
assert_eq!(limits.get("data-form"), Some(Limits::DATA_FORM));
assert_eq!(limits.get("file"), Some(1.mebibytes()));
assert_eq!(limits.get("file/png"), Some(1.mebibytes()));
assert_eq!(limits.get("file/jpeg"), Some(4.mebibytes()));
assert_eq!(limits.get("file/jpeg/inner"), Some(4.mebibytes()));
assert_eq!(limits.get("file/jpeg/special"), Some(8.mebibytes()));
assert!(limits.get("cats").is_none());
sourcepub fn find<S: AsRef<str>, L: AsRef<[S]>>(&self, layers: L) -> Option<ByteUnit>
pub fn find<S: AsRef<str>, L: AsRef<[S]>>(&self, layers: L) -> Option<ByteUnit>
Returns the limit for the name created by joining the strings in
layers
with /
as a separator, then proceeding like
Limits::get()
, hierarchically from right to left until one is found,
or returning None
if none is found.
This methods exists to allow finding hierarchical limits without
constructing a string to call get()
with but otherwise returns the
same results.
Example
use rocket::data::{Limits, ToByteUnit};
let limits = Limits::default()
.limit("json", 2.mebibytes())
.limit("file/jpeg", 4.mebibytes())
.limit("file/jpeg/special", 8.mebibytes());
assert_eq!(limits.find(["json"]), Some(2.mebibytes()));
assert_eq!(limits.find(["json", "person"]), Some(2.mebibytes()));
assert_eq!(limits.find(["file"]), Some(1.mebibytes()));
assert_eq!(limits.find(["file", "png"]), Some(1.mebibytes()));
assert_eq!(limits.find(["file", "jpeg"]), Some(4.mebibytes()));
assert_eq!(limits.find(["file", "jpeg", "inner"]), Some(4.mebibytes()));
assert_eq!(limits.find(["file", "jpeg", "special"]), Some(8.mebibytes()));
Trait Implementations§
source§impl<'de> Deserialize<'de> for Limits
impl<'de> Deserialize<'de> for Limits
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
source§impl<'r> FromRequest<'r> for &'r Limits
impl<'r> FromRequest<'r> for &'r Limits
§type Error = Infallible
type Error = Infallible
source§impl PartialEq<Limits> for Limits
impl PartialEq<Limits> for Limits
impl Eq for Limits
impl StructuralEq for Limits
impl StructuralPartialEq for Limits
Auto Trait Implementations§
impl RefUnwindSafe for Limits
impl Send for Limits
impl Sync for Limits
impl Unpin for Limits
impl UnwindSafe for Limits
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<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.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);