pub struct Ident(/* private fields */);
Expand description
An identifier (or None
) to send as the Server
header.
Deserialization
An Ident
deserializes from any of the following:
-
string
The string must be a valid
Ident
. SeeIdent::try_new()
for details. -
boolean
The boolean must be
false
. The value will beIdent::none()
. -
Option<string>
If
Some
, this is the same as deserializing from the inner string. IfNone
, the value isIdent::none()
. -
unit
Always deserializes as
Ident::none()
.
Examples
As with all Rocket configuration options, when using the default
Config::figment()
, Ident
can be configured
via a Rocket.toml
file. When no value for ident
is provided, the value
defaults to "Rocket"
. Because a default is provided, configuration only
needs to provided to customize or remove the value.
use rocket::config::{Config, Ident};
// If these are the contents of `Rocket.toml`...
[default]
ident = false
// The config parses as follows:
assert_eq!(config.ident, Ident::none());
// If these are the contents of `Rocket.toml`...
[default]
ident = "My Server"
// The config parses as follows:
assert_eq!(config.ident, Ident::try_new("My Server").unwrap());
The following example illustrates manual configuration:
use rocket::config::{Config, Ident};
let figment = rocket::Config::figment().merge(("ident", false));
let config = rocket::Config::from(figment);
assert_eq!(config.ident, Ident::none());
let figment = rocket::Config::figment().merge(("ident", "Fancy/1.0"));
let config = rocket::Config::from(figment);
assert_eq!(config.ident, Ident::try_new("Fancy/1.0").unwrap());
Implementations§
source§impl Ident
impl Ident
sourcepub fn try_new<S: Into<String>>(ident: S) -> Result<Ident, String>
pub fn try_new<S: Into<String>>(ident: S) -> Result<Ident, String>
Returns a new Ident
with the string ident
.
When configured as the Config::ident
, Rocket
will set a Server
header with the ident
value on all responses.
Errors
The string ident
must be non-empty and may only contain visible ASCII
characters. The first character cannot be whitespace. The only
whitespace characters allowed are
(space) and \t
(horizontal tab).
The string is returned wrapped in Err
if it contains any invalid
characters.
Example
use rocket::config::Ident;
let ident = Ident::try_new("Rocket").unwrap();
assert_eq!(ident.as_str(), Some("Rocket"));
let ident = Ident::try_new("Rocket Run").unwrap();
assert_eq!(ident.as_str(), Some("Rocket Run"));
let ident = Ident::try_new(" Rocket");
assert!(ident.is_err());
let ident = Ident::try_new("Rocket\nRun");
assert!(ident.is_err());
let ident = Ident::try_new("\tShip");
assert!(ident.is_err());
sourcepub const fn none() -> Ident
pub const fn none() -> Ident
Returns a new Ident
which is None
.
When configured as the Config::ident
, Rocket
will not set a Server
header on any response. Any Server
header
emitted by the application will still be written out.
Example
use rocket::config::Ident;
let ident = Ident::none();
assert_eq!(ident.as_str(), None);
sourcepub fn as_str(&self) -> Option<&str>
pub fn as_str(&self) -> Option<&str>
Returns self
as an Option<&str>
.
Example
use rocket::config::Ident;
let ident = Ident::try_new("Rocket").unwrap();
assert_eq!(ident.as_str(), Some("Rocket"));
let ident = Ident::try_new("Rocket/1 (Unix)").unwrap();
assert_eq!(ident.as_str(), Some("Rocket/1 (Unix)"));
let ident = Ident::none();
assert_eq!(ident.as_str(), None);
Trait Implementations§
source§impl<'de> Deserialize<'de> for Ident
impl<'de> Deserialize<'de> for Ident
source§fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>
source§impl PartialEq<Ident> for Ident
impl PartialEq<Ident> for Ident
impl StructuralPartialEq for Ident
Auto Trait Implementations§
impl RefUnwindSafe for Ident
impl Send for Ident
impl Sync for Ident
impl Unpin for Ident
impl UnwindSafe for Ident
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);