Struct rocket::form::ValueField
source · pub struct ValueField<'r> {
pub name: NameView<'r>,
pub value: &'r str,
}
Expand description
A form field with a string value.
Rocket preprocesses all form fields into either ValueField
s or
DataField
s. All fields from url-encoded forms, and fields without
Content-Types from multipart forms, are preprocessed as a ValueField
.
Fields§
§name: NameView<'r>
The (decoded) name of the form field.
value: &'r str
The (decoded) value of the form field.
Implementations§
source§impl<'v> ValueField<'v>
impl<'v> ValueField<'v>
sourcepub fn parse(field: &'v str) -> Self
pub fn parse(field: &'v str) -> Self
Parse a field string, where both the key and value are assumed to be
URL-decoded while preserving the =
delimiter, into a ValueField
.
This implements 3.2, 3.3 of section 5.1 of the WHATWG living standard.
Example
use rocket::form::ValueField;
let parsed = ValueField::parse("a cat=an A+ pet");
assert_eq!(parsed.name, "a cat");
assert_eq!(parsed.value, "an A+ pet");
let parsed = ValueField::parse("a cat is an A+ pet");
assert_eq!(parsed.name, "a cat is an A+ pet");
assert_eq!(parsed.value, "");
let parsed = ValueField::parse("cat.food=yum?");
assert_eq!(parsed.name, "cat");
assert_eq!(parsed.name.source(), "cat.food");
assert_eq!(parsed.value, "yum?");
sourcepub fn from_value(value: &'v str) -> Self
pub fn from_value(value: &'v str) -> Self
Create a ValueField
from a value, which is assumed to be URL-decoded.
The field name
will be empty.
This is equivalent to ValueField::from(("", value))
. To create a
ValueField
from both a name
and a value
, use
ValueField::from((name, value))
.
Example
use rocket::form::ValueField;
let parsed = ValueField::from_value("A+=kitten");
assert_eq!(parsed.name, "");
assert_eq!(parsed.value, "A+=kitten");
sourcepub fn shift(self) -> Self
pub fn shift(self) -> Self
Shift the name
of self
and return self
with the shifted name
.
See NameView::shift()
for the details on name “shifting”.
Example
use rocket::form::ValueField;
let parsed = ValueField::parse("cat.food=yum?");
assert_eq!(parsed.name, "cat");
assert_eq!(parsed.name.source(), "cat.food");
assert_eq!(parsed.name.key_lossy(), "cat");
let shifted = parsed.shift();
assert_eq!(shifted.name, "cat.food");
assert_eq!(shifted.name.key_lossy(), "food");
sourcepub fn unexpected(&self) -> Error<'v>
pub fn unexpected(&self) -> Error<'v>
Creates a complete unexpected value field Error
from self
.
The error will have the following properties:
kind
:ErrorKind::Unexpected
name
:self.name.source()
value
:self.value
entity
:Entity::ValueField
Example
use rocket::form::ValueField;
use rocket::form::error::{ErrorKind, Entity};
let field = ValueField::parse("cat.food=yum?");
let error = field.unexpected();
assert_eq!(error.name.as_ref().unwrap(), "cat.food");
assert_eq!(error.value.as_ref().unwrap(), "yum?");
assert_eq!(error.kind, ErrorKind::Unexpected);
assert_eq!(error.entity, Entity::ValueField);
sourcepub fn missing(&self) -> Error<'v>
pub fn missing(&self) -> Error<'v>
Creates a complete missing value field Error
from self
.
The error will have the following properties:
kind
:ErrorKind::Missing
name
:self.name.source()
value
:self.value
entity
:Entity::ValueField
Example
use rocket::form::ValueField;
use rocket::form::error::{ErrorKind, Entity};
let field = ValueField::parse("cat.food=yum?");
let error = field.missing();
assert_eq!(error.name.as_ref().unwrap(), "cat.food");
assert_eq!(error.value.as_ref().unwrap(), "yum?");
assert_eq!(error.kind, ErrorKind::Missing);
assert_eq!(error.entity, Entity::ValueField);
Trait Implementations§
source§impl<'r> Clone for ValueField<'r>
impl<'r> Clone for ValueField<'r>
source§fn clone(&self) -> ValueField<'r>
fn clone(&self) -> ValueField<'r>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'r> Debug for ValueField<'r>
impl<'r> Debug for ValueField<'r>
source§impl<'a, 'b> PartialEq<ValueField<'b>> for ValueField<'a>
impl<'a, 'b> PartialEq<ValueField<'b>> for ValueField<'a>
source§fn eq(&self, other: &ValueField<'b>) -> bool
fn eq(&self, other: &ValueField<'b>) -> bool
self
and other
values to be equal, and is used
by ==
.Auto Trait Implementations§
impl<'r> RefUnwindSafe for ValueField<'r>
impl<'r> Send for ValueField<'r>
impl<'r> Sync for ValueField<'r>
impl<'r> Unpin for ValueField<'r>
impl<'r> UnwindSafe for ValueField<'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);