pub struct NameView<'v> { /* private fields */ }
Expand description
A sliding-prefix view into a Name
.
A NameView
maintains a sliding key view into a Name
. The current key
(key()
) can be shift()
ed one key to the right.
The Name
prefix including the current key can be extracted via
as_name()
and the prefix not including the current key via
parent()
.
This is best illustrated via an example:
use rocket::form::name::NameView;
// The view begins at the first key. Illustrated: `(a).b[c:d]` where
// parenthesis enclose the current key.
let mut view = NameView::new("a.b[c:d]");
assert_eq!(view.key().unwrap(), "a");
assert_eq!(view.as_name(), "a");
assert_eq!(view.parent(), None);
// Shifted once to the right views the second key: `a.(b)[c:d]`.
view.shift();
assert_eq!(view.key().unwrap(), "b");
assert_eq!(view.as_name(), "a.b");
assert_eq!(view.parent().unwrap(), "a");
// Shifting again now has predictable results: `a.b[(c:d)]`.
view.shift();
assert_eq!(view.key().unwrap(), "c:d");
assert_eq!(view.as_name(), "a.b[c:d]");
assert_eq!(view.parent().unwrap(), "a.b");
// Shifting past the end means we have no further keys.
view.shift();
assert_eq!(view.key(), None);
assert_eq!(view.key_lossy(), "");
assert_eq!(view.as_name(), "a.b[c:d]");
assert_eq!(view.parent().unwrap(), "a.b[c:d]");
view.shift();
assert_eq!(view.key(), None);
assert_eq!(view.as_name(), "a.b[c:d]");
assert_eq!(view.parent().unwrap(), "a.b[c:d]");
Equality
PartialEq
, Eq
, and Hash
all operate on the name prefix including the
current key. Only key values are compared; delimiters are insignificant.
Again, illustrated via examples:
use rocket::form::name::NameView;
let mut view = NameView::new("a.b[c:d]");
assert_eq!(view, "a");
// Shifted once to the right views the second key: `a.(b)[c:d]`.
view.shift();
assert_eq!(view.key().unwrap(), "b");
assert_eq!(view.as_name(), "a.b");
assert_eq!(view, "a.b");
assert_eq!(view, "a[b]");
// Shifting again now has predictable results: `a.b[(c:d)]`.
view.shift();
assert_eq!(view, "a.b[c:d]");
assert_eq!(view, "a.b.c:d");
assert_eq!(view, "a[b].c:d");
assert_eq!(view, "a[b]c:d");
Implementations§
source§impl<'v> NameView<'v>
impl<'v> NameView<'v>
sourcepub fn new<N: Into<&'v Name>>(name: N) -> Self
pub fn new<N: Into<&'v Name>>(name: N) -> Self
Initializes a new NameView
at the first key of name
.
Example
use rocket::form::name::NameView;
let mut view = NameView::new("a.b[c:d]");
assert_eq!(view.key().unwrap(), "a");
assert_eq!(view.as_name(), "a");
assert_eq!(view.parent(), None);
sourcepub fn shift(&mut self)
pub fn shift(&mut self)
Shifts the current key once to the right.
Examples
use rocket::form::name::NameView;
let mut view = NameView::new("a.b[c:d][d.e]");
assert_eq!(view.key().unwrap(), "a");
view.shift();
assert_eq!(view.key().unwrap(), "b");
view.shift();
assert_eq!(view.key().unwrap(), "c:d");
view.shift();
assert_eq!(view.key().unwrap(), "d.e");
Malformed strings can have interesting results:
use rocket::form::name::NameView;
let mut view = NameView::new("a[c.d");
assert_eq!(view.key_lossy(), "a");
view.shift();
assert_eq!(view.key_lossy(), "c.d");
let mut view = NameView::new("a[c[.d]");
assert_eq!(view.key_lossy(), "a");
view.shift();
assert_eq!(view.key_lossy(), "c[.d");
view.shift();
assert_eq!(view.key(), None);
let mut view = NameView::new("foo[c[.d]]");
assert_eq!(view.key_lossy(), "foo");
view.shift();
assert_eq!(view.key_lossy(), "c[.d");
view.shift();
assert_eq!(view.key_lossy(), "]");
view.shift();
assert_eq!(view.key(), None);
sourcepub fn key(&self) -> Option<&'v Key>
pub fn key(&self) -> Option<&'v Key>
Returns the key currently viewed by self
if it is non-empty.
food.bart[bar:foo].blam[0_0][][1000]=some-value
name |----------------------------------|
non-empty key |--| |--| |-----| |--| |-| |--|
empty key |-|
Example
use rocket::form::name::NameView;
let mut view = NameView::new("a[b]");
assert_eq!(view.key().unwrap(), "a");
view.shift();
assert_eq!(view.key().unwrap(), "b");
view.shift();
assert_eq!(view.key(), None);
sourcepub fn key_lossy(&self) -> &'v Key
pub fn key_lossy(&self) -> &'v Key
Returns the key currently viewed by self
, even if it is non-empty.
food.bart[bar:foo].blam[0_0][][1000]=some-value
name |----------------------------------|
non-empty key |--| |--| |-----| |--| |-| |--|
empty key |-|
Example
use rocket::form::name::NameView;
let mut view = NameView::new("a[b]");
assert_eq!(view.key_lossy(), "a");
view.shift();
assert_eq!(view.key_lossy(), "b");
view.shift();
assert_eq!(view.key_lossy(), "");
sourcepub fn as_name(&self) -> &'v Name
pub fn as_name(&self) -> &'v Name
Returns the Name
up to and including the current key.
Example
use rocket::form::name::NameView;
let mut view = NameView::new("a[b]");
assert_eq!(view.as_name(), "a");
view.shift();
assert_eq!(view.as_name(), "a[b]");
sourcepub fn parent(&self) -> Option<&'v Name>
pub fn parent(&self) -> Option<&'v Name>
Returns the Name
prior to the current key.
Example
use rocket::form::name::NameView;
let mut view = NameView::new("a[b]");
assert_eq!(view.parent(), None);
view.shift();
assert_eq!(view.parent().unwrap(), "a");
view.shift();
assert_eq!(view.parent().unwrap(), "a[b]");
Trait Implementations§
source§impl<'a, 'b> PartialEq<NameView<'b>> for NameView<'a>
impl<'a, 'b> PartialEq<NameView<'b>> for NameView<'a>
impl<'v> Copy for NameView<'v>
impl Eq for NameView<'_>
Auto Trait Implementations§
impl<'v> RefUnwindSafe for NameView<'v>
impl<'v> Send for NameView<'v>
impl<'v> Sync for NameView<'v>
impl<'v> Unpin for NameView<'v>
impl<'v> UnwindSafe for NameView<'v>
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);