pub struct State<T: Send + Sync + 'static>(/* private fields */);
Expand description
Request guard to retrieve managed state.
A reference &State<T>
type is a request guard which retrieves the managed
state managing for some type T
. A value for the given type must previously
have been registered to be managed by Rocket via Rocket::manage()
. The
type being managed must be thread safe and sendable across thread
boundaries as multiple handlers in multiple threads may be accessing the
value at once. In other words, it must implement Send
+ Sync
+
'static
.
Example
Imagine you have some configuration struct of the type MyConfig
that you’d
like to initialize at start-up and later access it in several handlers. The
following example does just this:
use rocket::State;
// In a real application, this would likely be more complex.
struct MyConfig {
user_val: String
}
#[get("/")]
fn index(state: &State<MyConfig>) -> String {
format!("The config value is: {}", state.user_val)
}
#[get("/raw")]
fn raw_config_value(state: &State<MyConfig>) -> &str {
&state.user_val
}
#[launch]
fn rocket() -> _ {
rocket::build()
.mount("/", routes![index, raw_config_value])
.manage(MyConfig { user_val: "user input".to_string() })
}
Within Request Guards
Because State
is itself a request guard, managed state can be retrieved
from another request guard’s implementation using either
Request::guard()
or Rocket::state()
. In the following code example,
the Item
request guard retrieves MyConfig
from managed state:
use rocket::State;
use rocket::request::{self, Request, FromRequest};
use rocket::outcome::IntoOutcome;
use rocket::http::Status;
struct Item<'r>(&'r str);
#[rocket::async_trait]
impl<'r> FromRequest<'r> for Item<'r> {
type Error = ();
async fn from_request(request: &'r Request<'_>) -> request::Outcome<Self, ()> {
// Using `State` as a request guard. Use `inner()` to get an `'r`.
let outcome = request.guard::<&State<MyConfig>>().await
.map(|my_config| Item(&my_config.user_val));
// Or alternatively, using `Rocket::state()`:
let outcome = request.rocket().state::<MyConfig>()
.map(|my_config| Item(&my_config.user_val))
.or_forward(Status::InternalServerError);
outcome
}
}
Testing with State
When unit testing your application, you may find it necessary to manually
construct a type of State
to pass to your functions. To do so, use the
State::get()
static method or the From<&T>
implementation:
use rocket::State;
struct MyManagedState(usize);
#[get("/")]
fn handler(state: &State<MyManagedState>) -> String {
state.0.to_string()
}
let mut rocket = rocket::build().manage(MyManagedState(127));
let state = State::get(&rocket).expect("managed `MyManagedState`");
assert_eq!(handler(state), "127");
let managed = MyManagedState(77);
assert_eq!(handler(State::from(&managed)), "77");
Implementations§
source§impl<T: Send + Sync + 'static> State<T>
impl<T: Send + Sync + 'static> State<T>
sourcepub fn get<P: Phase>(rocket: &Rocket<P>) -> Option<&State<T>>
pub fn get<P: Phase>(rocket: &Rocket<P>) -> Option<&State<T>>
Returns the managed state value in rocket
for the type T
if it is
being managed by rocket
. Otherwise, returns None
.
Example
use rocket::State;
#[derive(Debug, PartialEq)]
struct Managed(usize);
#[derive(Debug, PartialEq)]
struct Unmanaged(usize);
let rocket = rocket::build().manage(Managed(7));
let state: Option<&State<Managed>> = State::get(&rocket);
assert_eq!(state.map(|s| s.inner()), Some(&Managed(7)));
let state: Option<&State<Unmanaged>> = State::get(&rocket);
assert_eq!(state, None);
sourcepub fn inner(&self) -> &T
pub fn inner(&self) -> &T
Borrow the inner value.
Using this method is typically unnecessary as State
implements
Deref
with a Deref::Target
of T
. This means Rocket will
automatically coerce a State<T>
to an &T
as required. This method
should only be used when a longer lifetime is required.
Example
use rocket::State;
#[derive(Clone)]
struct MyConfig {
user_val: String
}
fn handler1<'r>(config: &State<MyConfig>) -> String {
let config = config.inner().clone();
config.user_val
}
// Use the `Deref` implementation which coerces implicitly
fn handler2(config: &State<MyConfig>) -> String {
config.user_val.clone()
}
Trait Implementations§
source§impl<T: Ord + Send + Sync + 'static> Ord for State<T>
impl<T: Ord + Send + Sync + 'static> Ord for State<T>
source§impl<T: PartialEq + Send + Sync + 'static> PartialEq<State<T>> for State<T>
impl<T: PartialEq + Send + Sync + 'static> PartialEq<State<T>> for State<T>
source§impl<T: PartialOrd + Send + Sync + 'static> PartialOrd<State<T>> for State<T>
impl<T: PartialOrd + Send + Sync + 'static> PartialOrd<State<T>> for State<T>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl<T: Eq + Send + Sync + 'static> Eq for State<T>
impl<T: Send + Sync + 'static> StructuralEq for State<T>
impl<T: Send + Sync + 'static> StructuralPartialEq for State<T>
Auto Trait Implementations§
impl<T> RefUnwindSafe for State<T>where T: RefUnwindSafe,
impl<T> Send for State<T>
impl<T> Sync for State<T>
impl<T> Unpin for State<T>where T: Unpin,
impl<T> UnwindSafe for State<T>where T: UnwindSafe,
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);