Struct rocket::form::name::NameView

source ·
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>

source

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);
source

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);
source

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);
source

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(), "");
source

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]");
source

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]");
source

pub fn source(&self) -> &'v Name

Returns the underlying Name.

§Example
use rocket::form::name::NameView;

let mut view = NameView::new("a[b]");
assert_eq!(view.source(), "a[b]");

view.shift();
assert_eq!(view.source(), "a[b]");

view.shift();
assert_eq!(view.source(), "a[b]");

Trait Implementations§

source§

impl Borrow<Name> for NameView<'_>

source§

fn borrow(&self) -> &Name

Immutably borrows from an owned value. Read more
source§

impl<'v> Clone for NameView<'v>

source§

fn clone(&self) -> NameView<'v>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for NameView<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for NameView<'_>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'v> From<NameView<'v>> for NameBuf<'v>

source§

fn from(nv: NameView<'v>) -> Self

Converts to this type from the input type.
source§

impl Hash for NameView<'_>

source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<B: PartialEq<Name>> PartialEq<B> for NameView<'_>

source§

fn eq(&self, other: &B) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'a, 'b> PartialEq<NameView<'b>> for NameView<'a>

source§

fn eq(&self, other: &NameView<'b>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'v> Copy for NameView<'v>

source§

impl Eq for NameView<'_>

Auto Trait Implementations§

§

impl<'v> Freeze for NameView<'v>

§

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> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

source§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Paint for T
where T: ?Sized,

source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

§Example
println!("{}", value.primary());
source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

§Example
println!("{}", value.fixed(color));
source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

§Example
println!("{}", value.rgb(r, g, b));
source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

§Example
println!("{}", value.black());
source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

§Example
println!("{}", value.red());
source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

§Example
println!("{}", value.green());
source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

§Example
println!("{}", value.yellow());
source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

§Example
println!("{}", value.blue());
source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

§Example
println!("{}", value.magenta());
source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

§Example
println!("{}", value.cyan());
source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

§Example
println!("{}", value.white());
source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlack.

§Example
println!("{}", value.bright_black());
source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightRed.

§Example
println!("{}", value.bright_red());
source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightGreen.

§Example
println!("{}", value.bright_green());
source§

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>

Returns self with the fg() set to Color::BrightBlue.

§Example
println!("{}", value.bright_blue());
source§

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>

Returns self with the fg() set to Color::BrightCyan.

§Example
println!("{}", value.bright_cyan());
source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightWhite.

§Example
println!("{}", value.bright_white());
source§

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>

Returns self with the bg() set to Color::Primary.

§Example
println!("{}", value.on_primary());
source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

§Example
println!("{}", value.on_fixed(color));
source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

§Example
println!("{}", value.on_rgb(r, g, b));
source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

§Example
println!("{}", value.on_black());
source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

§Example
println!("{}", value.on_red());
source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

§Example
println!("{}", value.on_green());
source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

§Example
println!("{}", value.on_yellow());
source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

§Example
println!("{}", value.on_blue());
source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

§Example
println!("{}", value.on_magenta());
source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

§Example
println!("{}", value.on_cyan());
source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

§Example
println!("{}", value.on_white());
source§

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>

Returns self with the bg() set to Color::BrightRed.

§Example
println!("{}", value.on_bright_red());
source§

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>

Returns self with the bg() set to Color::BrightYellow.

§Example
println!("{}", value.on_bright_yellow());
source§

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>

Returns self with the bg() set to Color::BrightMagenta.

§Example
println!("{}", value.on_bright_magenta());
source§

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>

Returns self with the bg() set to Color::BrightWhite.

§Example
println!("{}", value.on_bright_white());
source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

§Example
println!("{}", value.bold());
source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

§Example
println!("{}", value.dim());
source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

§Example
println!("{}", value.italic());
source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

§Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

§Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

§Example
println!("{}", value.rapid_blink());
source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

§Example
println!("{}", value.invert());
source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

§Example
println!("{}", value.conceal());
source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

§Example
println!("{}", value.strike());
source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

§Example
println!("{}", value.mask());
source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

§Example
println!("{}", value.wrap());
source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

§Example
println!("{}", value.linger());
source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to Quirk::Clear.

§Example
println!("{}", value.clear());
source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Resetting.

§Example
println!("{}", value.resetting());
source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

§Example
println!("{}", value.bright());
source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

§Example
println!("{}", value.on_bright());
source§

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);
source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T, U> Upcast<T> for U
where T: UpcastFrom<U>,

source§

fn upcast(self) -> T

source§

impl<T, B> UpcastFrom<Counter<T, B>> for T

source§

fn upcast_from(value: Counter<T, B>) -> T

source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> CustomEndpoint for T
where T: Display + Debug + Sync + Send + Any,