pub enum StalledStreamProtectionInterceptorKind {
    RequestBody,
    ResponseBody,
    RequestAndResponseBody,
}
๐Ÿ‘ŽDeprecated since 1.2.0: This kind enum is no longer used. Configuration is stored in StalledStreamProtectionConfig in the config bag.
Available on crate feature client only.
Expand description

Stalled stream protection can be enable for request bodies, response bodies, or both.

Variantsยง

ยง

RequestBody

๐Ÿ‘ŽDeprecated since 1.2.0: This kind enum is no longer used. Configuration is stored in StalledStreamProtectionConfig in the config bag.

Enable stalled stream protection for request bodies.

ยง

ResponseBody

๐Ÿ‘ŽDeprecated since 1.2.0: This kind enum is no longer used. Configuration is stored in StalledStreamProtectionConfig in the config bag.

Enable stalled stream protection for response bodies.

ยง

RequestAndResponseBody

๐Ÿ‘ŽDeprecated since 1.2.0: This kind enum is no longer used. Configuration is stored in StalledStreamProtectionConfig in the config bag.

Enable stalled stream protection for both request and response bodies.

Auto Trait Implementationsยง

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<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> From<T> for T

sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

ยง

impl<T> Instrument for T

ยง

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
ยง

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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

sourceยง

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
ยง

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

ยง

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();
ยง

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

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

ยงExample
println!("{}", value.primary());
ยง

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

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

ยงExample
println!("{}", value.fixed(color));
ยง

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));
ยง

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

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

ยงExample
println!("{}", value.black());
ยง

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

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

ยงExample
println!("{}", value.red());
ยง

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

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

ยงExample
println!("{}", value.green());
ยง

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

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

ยงExample
println!("{}", value.yellow());
ยง

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

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

ยงExample
println!("{}", value.blue());
ยง

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

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

ยงExample
println!("{}", value.magenta());
ยง

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

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

ยงExample
println!("{}", value.cyan());
ยง

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

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

ยงExample
println!("{}", value.white());
ยง

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

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

ยงExample
println!("{}", value.bright_black());
ยง

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

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

ยงExample
println!("{}", value.bright_red());
ยง

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

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

ยงExample
println!("{}", value.bright_green());
ยง

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

Returns self with the fg() set to [Color::BrightYellow].

ยงExample
println!("{}", value.bright_yellow());
ยง

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

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

ยงExample
println!("{}", value.bright_blue());
ยง

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

Returns self with the fg() set to [Color::BrightMagenta].

ยงExample
println!("{}", value.bright_magenta());
ยง

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

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

ยงExample
println!("{}", value.bright_cyan());
ยง

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

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

ยงExample
println!("{}", value.bright_white());
ยง

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();
ยง

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

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

ยงExample
println!("{}", value.on_primary());
ยง

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

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

ยงExample
println!("{}", value.on_fixed(color));
ยง

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));
ยง

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

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

ยงExample
println!("{}", value.on_black());
ยง

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

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

ยงExample
println!("{}", value.on_red());
ยง

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

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

ยงExample
println!("{}", value.on_green());
ยง

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

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

ยงExample
println!("{}", value.on_yellow());
ยง

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

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

ยงExample
println!("{}", value.on_blue());
ยง

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

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

ยงExample
println!("{}", value.on_magenta());
ยง

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

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

ยงExample
println!("{}", value.on_cyan());
ยง

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

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

ยงExample
println!("{}", value.on_white());
ยง

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

Returns self with the bg() set to [Color::BrightBlack].

ยงExample
println!("{}", value.on_bright_black());
ยง

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

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

ยงExample
println!("{}", value.on_bright_red());
ยง

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

Returns self with the bg() set to [Color::BrightGreen].

ยงExample
println!("{}", value.on_bright_green());
ยง

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

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

ยงExample
println!("{}", value.on_bright_yellow());
ยง

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

Returns self with the bg() set to [Color::BrightBlue].

ยงExample
println!("{}", value.on_bright_blue());
ยง

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

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

ยงExample
println!("{}", value.on_bright_magenta());
ยง

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

Returns self with the bg() set to [Color::BrightCyan].

ยงExample
println!("{}", value.on_bright_cyan());
ยง

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

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

ยงExample
println!("{}", value.on_bright_white());
ยง

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();
ยง

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

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

ยงExample
println!("{}", value.bold());
ยง

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

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

ยงExample
println!("{}", value.dim());
ยง

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

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

ยงExample
println!("{}", value.italic());
ยง

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());
ยง

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

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

ยงExample
println!("{}", value.invert());
ยง

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

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

ยงExample
println!("{}", value.conceal());
ยง

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

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

ยงExample
println!("{}", value.strike());
ยง

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();
ยง

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

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

ยงExample
println!("{}", value.mask());
ยง

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

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

ยงExample
println!("{}", value.wrap());
ยง

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

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

ยงExample
println!("{}", value.linger());
ยง

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());
ยง

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

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

ยงExample
println!("{}", value.resetting());
ยง

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

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

ยงExample
println!("{}", value.bright());
ยง

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

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

ยงExample
println!("{}", value.on_bright());
ยง

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);
ยง

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

Create a new [Painted] with a default [Style]. Read more
ยง

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, 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.
ยง

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

ยง

fn vzip(self) -> V

ยง

impl<T> WithSubscriber for T

ยง

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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