aws_sdk_pi::types

Struct DimensionGroup

Source 
#[non_exhaustive]
pub struct DimensionGroup {
    pub group: String,
    pub dimensions: Option<Vec<String>>,
    pub limit: Option<i32>,
}
Expand description

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions:

  • db.sql.id - The hash of a running SQL statement, generated by Performance Insights.

  • db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.

  • db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.

  • db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§group: String

The name of the dimension group. Valid values are as follows:

  • db - The name of the database to which the client is connected. The following values are permitted:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Aurora MySQL

    • Amazon RDS MySQL

    • Amazon RDS MariaDB

    • Amazon DocumentDB

  • db.application - The name of the application that is connected to the database. The following values are permitted:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Amazon DocumentDB

  • db.blocking_sql - The SQL queries blocking the most DB load.

  • db.blocking_session - The sessions blocking the most DB load.

  • db.blocking_object - The object resources acquired by other sessions that are blocking the most DB load.

  • db.host - The host name of the connected client (all engines).

  • db.plans - The execution plans for the query (only Aurora PostgreSQL).

  • db.query - The query that is currently running (only Amazon DocumentDB).

  • db.query_tokenized - The digest query (only Amazon DocumentDB).

  • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).

  • db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).

  • db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).

  • db.user - The user logged in to the database (all engines except Amazon DocumentDB).

  • db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).

§dimensions: Option<Vec<String>>

A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.

Valid values for elements in the Dimensions array are:

  • db.application.name - The name of the application that is connected to the database. Valid values are as follows:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Amazon DocumentDB

  • db.blocking_sql.id - The ID for each of the SQL queries blocking the most DB load.

  • db.blocking_sql.sql - The SQL text for each of the SQL queries blocking the most DB load.

  • db.blocking_session.id - The ID for each of the sessions blocking the most DB load.

  • db.blocking_object.id - The ID for each of the object resources acquired by other sessions that are blocking the most DB load.

  • db.blocking_object.type - The object type for each of the object resources acquired by other sessions that are blocking the most DB load.

  • db.blocking_object.value - The value for each of the object resources acquired by other sessions that are blocking the most DB load.

  • db.host.id - The host ID of the connected client (all engines).

  • db.host.name - The host name of the connected client (all engines).

  • db.name - The name of the database to which the client is connected. Valid values are as follows:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Aurora MySQL

    • Amazon RDS MySQL

    • Amazon RDS MariaDB

    • Amazon DocumentDB

  • db.query.id - The query ID generated by Performance Insights (only Amazon DocumentDB).

  • db.query.db_id - The query ID generated by the database (only Amazon DocumentDB).

  • db.query.statement - The text of the query that is being run (only Amazon DocumentDB).

  • db.query.tokenized_id

  • db.query.tokenized.id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

  • db.query.tokenized.db_id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

  • db.query.tokenized.statement - The text of the query digest (only Amazon DocumentDB).

  • db.session_type.name - The type of the current session (only Amazon DocumentDB).

  • db.sql.id - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).

  • db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi- (all engines except Amazon DocumentDB).

  • db.sql.statement - The full text of the SQL statement that is running, as in SELECT * FROM employees (all engines except Amazon DocumentDB)

  • db.sql.tokenized_id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The db.sql.tokenized_id dimension fetches the value of the db.sql_tokenized.id dimension. Amazon RDS returns db.sql.tokenized_id from the db.sql dimension group.

  • db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.

  • db.sql_tokenized.db_id - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).

  • db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)

  • db.user.id - The ID of the user logged in to the database (all engines except Amazon DocumentDB).

  • db.user.name - The name of the user logged in to the database (all engines except Amazon DocumentDB).

  • db.wait_event.name - The event for which the backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_event.type - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_state.name - The event for which the backend is waiting (only Amazon DocumentDB).

§limit: Option<i32>

The maximum number of items to fetch for this dimension group.

Implementations§

Source§

impl DimensionGroup

Source

pub fn group(&self) -> &str

The name of the dimension group. Valid values are as follows:

  • db - The name of the database to which the client is connected. The following values are permitted:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Aurora MySQL

    • Amazon RDS MySQL

    • Amazon RDS MariaDB

    • Amazon DocumentDB

  • db.application - The name of the application that is connected to the database. The following values are permitted:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Amazon DocumentDB

  • db.blocking_sql - The SQL queries blocking the most DB load.

  • db.blocking_session - The sessions blocking the most DB load.

  • db.blocking_object - The object resources acquired by other sessions that are blocking the most DB load.

  • db.host - The host name of the connected client (all engines).

  • db.plans - The execution plans for the query (only Aurora PostgreSQL).

  • db.query - The query that is currently running (only Amazon DocumentDB).

  • db.query_tokenized - The digest query (only Amazon DocumentDB).

  • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).

  • db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).

  • db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).

  • db.user - The user logged in to the database (all engines except Amazon DocumentDB).

  • db.wait_event - The event for which the database backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_event_type - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).

Source

pub fn dimensions(&self) -> &[String]

A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.

Valid values for elements in the Dimensions array are:

  • db.application.name - The name of the application that is connected to the database. Valid values are as follows:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Amazon DocumentDB

  • db.blocking_sql.id - The ID for each of the SQL queries blocking the most DB load.

  • db.blocking_sql.sql - The SQL text for each of the SQL queries blocking the most DB load.

  • db.blocking_session.id - The ID for each of the sessions blocking the most DB load.

  • db.blocking_object.id - The ID for each of the object resources acquired by other sessions that are blocking the most DB load.

  • db.blocking_object.type - The object type for each of the object resources acquired by other sessions that are blocking the most DB load.

  • db.blocking_object.value - The value for each of the object resources acquired by other sessions that are blocking the most DB load.

  • db.host.id - The host ID of the connected client (all engines).

  • db.host.name - The host name of the connected client (all engines).

  • db.name - The name of the database to which the client is connected. Valid values are as follows:

    • Aurora PostgreSQL

    • Amazon RDS PostgreSQL

    • Aurora MySQL

    • Amazon RDS MySQL

    • Amazon RDS MariaDB

    • Amazon DocumentDB

  • db.query.id - The query ID generated by Performance Insights (only Amazon DocumentDB).

  • db.query.db_id - The query ID generated by the database (only Amazon DocumentDB).

  • db.query.statement - The text of the query that is being run (only Amazon DocumentDB).

  • db.query.tokenized_id

  • db.query.tokenized.id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

  • db.query.tokenized.db_id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

  • db.query.tokenized.statement - The text of the query digest (only Amazon DocumentDB).

  • db.session_type.name - The type of the current session (only Amazon DocumentDB).

  • db.sql.id - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).

  • db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi- (all engines except Amazon DocumentDB).

  • db.sql.statement - The full text of the SQL statement that is running, as in SELECT * FROM employees (all engines except Amazon DocumentDB)

  • db.sql.tokenized_id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The db.sql.tokenized_id dimension fetches the value of the db.sql_tokenized.id dimension. Amazon RDS returns db.sql.tokenized_id from the db.sql dimension group.

  • db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.

  • db.sql_tokenized.db_id - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).

  • db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)

  • db.user.id - The ID of the user logged in to the database (all engines except Amazon DocumentDB).

  • db.user.name - The name of the user logged in to the database (all engines except Amazon DocumentDB).

  • db.wait_event.name - The event for which the backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_event.type - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).

  • db.wait_state.name - The event for which the backend is waiting (only Amazon DocumentDB).

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dimensions.is_none().

Source

pub fn limit(&self) -> Option<i32>

The maximum number of items to fetch for this dimension group.

Source§

impl DimensionGroup

Source

pub fn builder() -> DimensionGroupBuilder

Creates a new builder-style object to manufacture DimensionGroup.

Trait Implementations§

Source§

impl Clone for DimensionGroup

Source§

fn clone(&self) -> DimensionGroup

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DimensionGroup

Source§

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

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

impl PartialEq for DimensionGroup

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for DimensionGroup

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

Source§

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

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

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.
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<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> ErasedDestructor for T
where T: 'static,