rocket::http::uri::fmt

Enum Query

pub enum Query {}
Expand description

Marker type indicating use of a type for the query Part of a URI.

In route URIs, this corresponds to all of the text after a ?, if any.

#[get("/home/<name>/<page>?<item>&<form..>")]
                           ^-------------- Query

Trait Implementations§

§

impl Clone for Query

§

fn clone(&self) -> Query

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
§

impl Debug for Query

§

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

Formats the value using the given formatter. Read more
§

impl<'x, 'a> FromUriParam<Query, &'x &'a [u8]> for &'a [u8]

§

type Target = &'x &'a [u8]

The resulting type of this conversion.
§

fn from_uri_param(param: &'x &'a [u8]) -> &'x &'a [u8] ⓘ

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'x, T, A, const N: usize> FromUriParam<Query, &'x [A; N]> for [T; N]
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = &'x [A; N]

The resulting type of this conversion.
§

fn from_uri_param(param: &'x [A; N]) -> &'x [A; N]

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'x, T, A, const N: usize> FromUriParam<Query, &'x [A; N]> for Vec<T>
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = &'x [A; N]

The resulting type of this conversion.
§

fn from_uri_param(param: &'x [A; N]) -> &'x [A; N]

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'a> FromUriParam<Query, &'a [u8]> for &'a [u8]

§

type Target = &'a [u8]

The resulting type of this conversion.
§

fn from_uri_param(param: &'a [u8]) -> &'a [u8] ⓘ

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'a, K, V, A, B> FromUriParam<Query, &'a BTreeMap<A, B>> for BTreeMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = &'a BTreeMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: &'a BTreeMap<A, B>, ) -> <BTreeMap<K, V> as FromUriParam<Query, &'a BTreeMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'a, K, V, A, B> FromUriParam<Query, &'a BTreeMap<A, B>> for HashMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = &'a BTreeMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: &'a BTreeMap<A, B>, ) -> <HashMap<K, V> as FromUriParam<Query, &'a BTreeMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'a, K, V, A, B> FromUriParam<Query, &'a HashMap<A, B>> for BTreeMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = &'a HashMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: &'a HashMap<A, B>, ) -> <BTreeMap<K, V> as FromUriParam<Query, &'a HashMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'a, K, V, A, B> FromUriParam<Query, &'a HashMap<A, B>> for HashMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = &'a HashMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: &'a HashMap<A, B>, ) -> <HashMap<K, V> as FromUriParam<Query, &'a HashMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
Source§

impl<'x, T: Serialize> FromUriParam<Query, &'x Json<T>> for Json<T>

Available on crate feature json only.
Source§

type Target = &'x Json<T>

The resulting type of this conversion.
Source§

fn from_uri_param(param: &'x Json<T>) -> &'x Json<T>

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
Source§

impl<'a, T: Serialize> FromUriParam<Query, &'a T> for Json<T>

Available on crate feature json only.
Source§

type Target = Json<&'a T>

The resulting type of this conversion.
Source§

fn from_uri_param(param: &'a T) -> Self::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'x, T, A, const N: usize> FromUriParam<Query, &'x Vec<A>> for [T; N]
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = &'x Vec<A>

The resulting type of this conversion.
§

fn from_uri_param(param: &'x Vec<A>) -> &'x Vec<A>

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'x, T, A> FromUriParam<Query, &'x Vec<A>> for Vec<T>
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = &'x Vec<A>

The resulting type of this conversion.
§

fn from_uri_param(param: &'x Vec<A>) -> &'x Vec<A>

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'x, 'a> FromUriParam<Query, &'x mut &'a [u8]> for &'a [u8]

§

type Target = &'x mut &'a [u8]

The resulting type of this conversion.
§

fn from_uri_param(param: &'x mut &'a [u8]) -> &'x mut &'a [u8] ⓘ

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'x, T, A, const N: usize> FromUriParam<Query, &'x mut [A; N]> for [T; N]
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = &'x mut [A; N]

The resulting type of this conversion.
§

fn from_uri_param(param: &'x mut [A; N]) -> &'x mut [A; N]

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'x, T, A, const N: usize> FromUriParam<Query, &'x mut [A; N]> for Vec<T>
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = &'x mut [A; N]

The resulting type of this conversion.
§

fn from_uri_param(param: &'x mut [A; N]) -> &'x mut [A; N]

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'a, K, V, A, B> FromUriParam<Query, &'a mut BTreeMap<A, B>> for BTreeMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = &'a BTreeMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: &'a mut BTreeMap<A, B>, ) -> <BTreeMap<K, V> as FromUriParam<Query, &'a mut BTreeMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'a, K, V, A, B> FromUriParam<Query, &'a mut BTreeMap<A, B>> for HashMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = &'a BTreeMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: &'a mut BTreeMap<A, B>, ) -> <HashMap<K, V> as FromUriParam<Query, &'a mut BTreeMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'a, K, V, A, B> FromUriParam<Query, &'a mut HashMap<A, B>> for BTreeMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = &'a HashMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: &'a mut HashMap<A, B>, ) -> <BTreeMap<K, V> as FromUriParam<Query, &'a mut HashMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'a, K, V, A, B> FromUriParam<Query, &'a mut HashMap<A, B>> for HashMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = &'a HashMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: &'a mut HashMap<A, B>, ) -> <HashMap<K, V> as FromUriParam<Query, &'a mut HashMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
Source§

impl<'x, T: Serialize> FromUriParam<Query, &'x mut Json<T>> for Json<T>

Available on crate feature json only.
Source§

type Target = &'x mut Json<T>

The resulting type of this conversion.
Source§

fn from_uri_param(param: &'x mut Json<T>) -> &'x mut Json<T>

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
Source§

impl<'a, T: Serialize> FromUriParam<Query, &'a mut T> for Json<T>

Available on crate feature json only.
Source§

type Target = Json<&'a mut T>

The resulting type of this conversion.
Source§

fn from_uri_param(param: &'a mut T) -> Self::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'x, T, A, const N: usize> FromUriParam<Query, &'x mut Vec<A>> for [T; N]
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = &'x mut Vec<A>

The resulting type of this conversion.
§

fn from_uri_param(param: &'x mut Vec<A>) -> &'x mut Vec<A>

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<'x, T, A> FromUriParam<Query, &'x mut Vec<A>> for Vec<T>
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = &'x mut Vec<A>

The resulting type of this conversion.
§

fn from_uri_param(param: &'x mut Vec<A>) -> &'x mut Vec<A>

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<T, A, const N: usize> FromUriParam<Query, [A; N]> for [T; N]
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = [A; N]

The resulting type of this conversion.
§

fn from_uri_param(param: [A; N]) -> [A; N]

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<T, A, const N: usize> FromUriParam<Query, [A; N]> for Vec<T>
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = [A; N]

The resulting type of this conversion.
§

fn from_uri_param(param: [A; N]) -> [A; N]

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
Source§

impl<'f, A, T: FromUriParam<Query, A> + FromForm<'f>> FromUriParam<Query, A> for Lenient<T>

Source§

type Target = <T as FromUriParam<Query, A>>::Target

The resulting type of this conversion.
Source§

fn from_uri_param(param: A) -> Self::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
Source§

impl<'f, A, T: FromUriParam<Query, A> + FromForm<'f>> FromUriParam<Query, A> for Strict<T>

Source§

type Target = <T as FromUriParam<Query, A>>::Target

The resulting type of this conversion.
Source§

fn from_uri_param(param: A) -> Self::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<K, V, A, B> FromUriParam<Query, BTreeMap<A, B>> for BTreeMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = BTreeMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: BTreeMap<A, B>, ) -> <BTreeMap<K, V> as FromUriParam<Query, BTreeMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<K, V, A, B> FromUriParam<Query, BTreeMap<A, B>> for HashMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = BTreeMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: BTreeMap<A, B>, ) -> <HashMap<K, V> as FromUriParam<Query, BTreeMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<K, V, A, B> FromUriParam<Query, HashMap<A, B>> for BTreeMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = HashMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: HashMap<A, B>, ) -> <BTreeMap<K, V> as FromUriParam<Query, HashMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<K, V, A, B> FromUriParam<Query, HashMap<A, B>> for HashMap<K, V>
where A: UriDisplay<Query>, K: FromUriParam<Query, A>, B: UriDisplay<Query>, V: FromUriParam<Query, B>,

§

type Target = HashMap<A, B>

The resulting type of this conversion.
§

fn from_uri_param( param: HashMap<A, B>, ) -> <HashMap<K, V> as FromUriParam<Query, HashMap<A, B>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
Source§

impl<T: Serialize> FromUriParam<Query, Json<T>> for Json<T>

Available on crate feature json only.
Source§

type Target = Json<T>

The resulting type of this conversion.
Source§

fn from_uri_param(param: Json<T>) -> Json<T>

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<A, T> FromUriParam<Query, Option<A>> for Option<T>
where T: FromUriParam<Query, A>,

§

type Target = Option<<T as FromUriParam<Query, A>>::Target>

The resulting type of this conversion.
§

fn from_uri_param( param: Option<A>, ) -> <Option<T> as FromUriParam<Query, Option<A>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<A, E, T> FromUriParam<Query, Option<A>> for Result<T, E>
where T: FromUriParam<Query, A>,

§

type Target = Option<<T as FromUriParam<Query, A>>::Target>

The resulting type of this conversion.
§

fn from_uri_param( param: Option<A>, ) -> <Result<T, E> as FromUriParam<Query, Option<A>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<A, E, T> FromUriParam<Query, Result<A, E>> for Option<T>
where T: FromUriParam<Query, A>,

§

type Target = Result<<T as FromUriParam<Query, A>>::Target, E>

The resulting type of this conversion.
§

fn from_uri_param( param: Result<A, E>, ) -> <Option<T> as FromUriParam<Query, Result<A, E>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<A, E, T> FromUriParam<Query, Result<A, E>> for Result<T, E>
where T: FromUriParam<Query, A>,

§

type Target = Result<<T as FromUriParam<Query, A>>::Target, E>

The resulting type of this conversion.
§

fn from_uri_param( param: Result<A, E>, ) -> <Result<T, E> as FromUriParam<Query, Result<A, E>>>::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
Source§

impl<T: Serialize> FromUriParam<Query, T> for Json<T>

Available on crate feature json only.
Source§

type Target = Json<T>

The resulting type of this conversion.
Source§

fn from_uri_param(param: T) -> Self::Target

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<T, A, const N: usize> FromUriParam<Query, Vec<A>> for [T; N]
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = Vec<A>

The resulting type of this conversion.
§

fn from_uri_param(param: Vec<A>) -> Vec<A>

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<T, A> FromUriParam<Query, Vec<A>> for Vec<T>
where A: FromUriParam<Query, T> + UriDisplay<Query>,

§

type Target = Vec<A>

The resulting type of this conversion.
§

fn from_uri_param(param: Vec<A>) -> Vec<A>

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation.
§

impl<T, const N: usize> UriDisplay<Query> for [T; N]
where T: UriDisplay<Query>,

§

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

Formats self in a URI-safe manner using the given formatter.
§

impl UriDisplay<Query> for [u8]

§

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

Formats self in a URI-safe manner using the given formatter.
§

impl<K, V> UriDisplay<Query> for BTreeMap<K, V>
where K: UriDisplay<Query>, V: UriDisplay<Query>,

§

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

Formats self in a URI-safe manner using the given formatter.
§

impl<K, V> UriDisplay<Query> for HashMap<K, V>
where K: UriDisplay<Query>, V: UriDisplay<Query>,

§

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

Formats self in a URI-safe manner using the given formatter.
Source§

impl<T: Serialize> UriDisplay<Query> for Json<T>

Available on crate feature json only.
Source§

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

Formats self in a URI-safe manner using the given formatter.
§

impl<T> UriDisplay<Query> for Option<T>
where T: UriDisplay<Query>,

Defers to the UriDisplay<Query> implementation for T.

§

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

Formats self in a URI-safe manner using the given formatter.
§

impl<T, E> UriDisplay<Query> for Result<T, E>
where T: UriDisplay<Query>,

Defers to the UriDisplay<Query> implementation for T.

§

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

Formats self in a URI-safe manner using the given formatter.
§

impl<T> UriDisplay<Query> for Vec<T>
where T: UriDisplay<Query>,

§

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

Formats self in a URI-safe manner using the given formatter.
§

impl Copy for Query

§

impl<T> Ignorable<Query> for Option<T>

§

impl<T, E> Ignorable<Query> for Result<T, E>

§

impl Part for Query

Auto Trait Implementations§

§

impl Freeze for Query

§

impl RefUnwindSafe for Query

§

impl Send for Query

§

impl Sync for Query

§

impl Unpin for Query

§

impl UnwindSafe for Query

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> AsTaggedExplicit<'a> for T
where T: 'a,

Source§

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

Source§

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

Source§

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

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
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.

§

impl<T> IntoCollection<T> for T

§

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

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

Source§

type Output = T

Should always be Self
Source§

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

Source§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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