Enum DataSourceParameters

Source
#[non_exhaustive]
pub enum DataSourceParameters {
Show 27 variants AmazonElasticsearchParameters(AmazonElasticsearchParameters), AmazonOpenSearchParameters(AmazonOpenSearchParameters), AthenaParameters(AthenaParameters), AuroraParameters(AuroraParameters), AuroraPostgreSqlParameters(AuroraPostgreSqlParameters), AwsIotAnalyticsParameters(AwsIotAnalyticsParameters), BigQueryParameters(BigQueryParameters), DatabricksParameters(DatabricksParameters), ExasolParameters(ExasolParameters), JiraParameters(JiraParameters), MariaDbParameters(MariaDbParameters), MySqlParameters(MySqlParameters), OracleParameters(OracleParameters), PostgreSqlParameters(PostgreSqlParameters), PrestoParameters(PrestoParameters), RdsParameters(RdsParameters), RedshiftParameters(RedshiftParameters), S3Parameters(S3Parameters), ServiceNowParameters(ServiceNowParameters), SnowflakeParameters(SnowflakeParameters), SparkParameters(SparkParameters), SqlServerParameters(SqlServerParameters), StarburstParameters(StarburstParameters), TeradataParameters(TeradataParameters), TrinoParameters(TrinoParameters), TwitterParameters(TwitterParameters), #[non_exhaustive] Unknown,
}
Expand description

The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

AmazonElasticsearchParameters(AmazonElasticsearchParameters)

The parameters for OpenSearch.

§

AmazonOpenSearchParameters(AmazonOpenSearchParameters)

The parameters for OpenSearch.

§

AthenaParameters(AthenaParameters)

The parameters for Amazon Athena.

§

AuroraParameters(AuroraParameters)

The parameters for Amazon Aurora MySQL.

§

AuroraPostgreSqlParameters(AuroraPostgreSqlParameters)

The parameters for Amazon Aurora.

§

AwsIotAnalyticsParameters(AwsIotAnalyticsParameters)

The parameters for IoT Analytics.

§

BigQueryParameters(BigQueryParameters)

The parameters that are required to connect to a Google BigQuery data source.

§

DatabricksParameters(DatabricksParameters)

The parameters that are required to connect to a Databricks data source.

§

ExasolParameters(ExasolParameters)

The parameters for Exasol.

§

JiraParameters(JiraParameters)

The parameters for Jira.

§

MariaDbParameters(MariaDbParameters)

The parameters for MariaDB.

§

MySqlParameters(MySqlParameters)

The parameters for MySQL.

§

OracleParameters(OracleParameters)

The parameters for Oracle.

§

PostgreSqlParameters(PostgreSqlParameters)

The parameters for PostgreSQL.

§

PrestoParameters(PrestoParameters)

The parameters for Presto.

§

RdsParameters(RdsParameters)

The parameters for Amazon RDS.

§

RedshiftParameters(RedshiftParameters)

The parameters for Amazon Redshift.

§

S3Parameters(S3Parameters)

The parameters for S3.

§

ServiceNowParameters(ServiceNowParameters)

The parameters for ServiceNow.

§

SnowflakeParameters(SnowflakeParameters)

The parameters for Snowflake.

§

SparkParameters(SparkParameters)

The parameters for Spark.

§

SqlServerParameters(SqlServerParameters)

The parameters for SQL Server.

§

StarburstParameters(StarburstParameters)

The parameters that are required to connect to a Starburst data source.

§

TeradataParameters(TeradataParameters)

The parameters for Teradata.

§

TrinoParameters(TrinoParameters)

The parameters that are required to connect to a Trino data source.

§

TwitterParameters(TwitterParameters)

The parameters for Twitter.

§

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations§

Source§

impl DataSourceParameters

Source

pub fn as_amazon_elasticsearch_parameters( &self, ) -> Result<&AmazonElasticsearchParameters, &Self>

Tries to convert the enum instance into AmazonElasticsearchParameters, extracting the inner AmazonElasticsearchParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_amazon_elasticsearch_parameters(&self) -> bool

Returns true if this is a AmazonElasticsearchParameters.

Source

pub fn as_amazon_open_search_parameters( &self, ) -> Result<&AmazonOpenSearchParameters, &Self>

Tries to convert the enum instance into AmazonOpenSearchParameters, extracting the inner AmazonOpenSearchParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_amazon_open_search_parameters(&self) -> bool

Returns true if this is a AmazonOpenSearchParameters.

Source

pub fn as_athena_parameters(&self) -> Result<&AthenaParameters, &Self>

Tries to convert the enum instance into AthenaParameters, extracting the inner AthenaParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_athena_parameters(&self) -> bool

Returns true if this is a AthenaParameters.

Source

pub fn as_aurora_parameters(&self) -> Result<&AuroraParameters, &Self>

Tries to convert the enum instance into AuroraParameters, extracting the inner AuroraParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_aurora_parameters(&self) -> bool

Returns true if this is a AuroraParameters.

Source

pub fn as_aurora_postgre_sql_parameters( &self, ) -> Result<&AuroraPostgreSqlParameters, &Self>

Tries to convert the enum instance into AuroraPostgreSqlParameters, extracting the inner AuroraPostgreSqlParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_aurora_postgre_sql_parameters(&self) -> bool

Returns true if this is a AuroraPostgreSqlParameters.

Source

pub fn as_aws_iot_analytics_parameters( &self, ) -> Result<&AwsIotAnalyticsParameters, &Self>

Tries to convert the enum instance into AwsIotAnalyticsParameters, extracting the inner AwsIotAnalyticsParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_aws_iot_analytics_parameters(&self) -> bool

Returns true if this is a AwsIotAnalyticsParameters.

Source

pub fn as_big_query_parameters(&self) -> Result<&BigQueryParameters, &Self>

Tries to convert the enum instance into BigQueryParameters, extracting the inner BigQueryParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_big_query_parameters(&self) -> bool

Returns true if this is a BigQueryParameters.

Source

pub fn as_databricks_parameters(&self) -> Result<&DatabricksParameters, &Self>

Tries to convert the enum instance into DatabricksParameters, extracting the inner DatabricksParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_databricks_parameters(&self) -> bool

Returns true if this is a DatabricksParameters.

Source

pub fn as_exasol_parameters(&self) -> Result<&ExasolParameters, &Self>

Tries to convert the enum instance into ExasolParameters, extracting the inner ExasolParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_exasol_parameters(&self) -> bool

Returns true if this is a ExasolParameters.

Source

pub fn as_jira_parameters(&self) -> Result<&JiraParameters, &Self>

Tries to convert the enum instance into JiraParameters, extracting the inner JiraParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_jira_parameters(&self) -> bool

Returns true if this is a JiraParameters.

Source

pub fn as_maria_db_parameters(&self) -> Result<&MariaDbParameters, &Self>

Tries to convert the enum instance into MariaDbParameters, extracting the inner MariaDbParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_maria_db_parameters(&self) -> bool

Returns true if this is a MariaDbParameters.

Source

pub fn as_my_sql_parameters(&self) -> Result<&MySqlParameters, &Self>

Tries to convert the enum instance into MySqlParameters, extracting the inner MySqlParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_my_sql_parameters(&self) -> bool

Returns true if this is a MySqlParameters.

Source

pub fn as_oracle_parameters(&self) -> Result<&OracleParameters, &Self>

Tries to convert the enum instance into OracleParameters, extracting the inner OracleParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_oracle_parameters(&self) -> bool

Returns true if this is a OracleParameters.

Source

pub fn as_postgre_sql_parameters(&self) -> Result<&PostgreSqlParameters, &Self>

Tries to convert the enum instance into PostgreSqlParameters, extracting the inner PostgreSqlParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_postgre_sql_parameters(&self) -> bool

Returns true if this is a PostgreSqlParameters.

Source

pub fn as_presto_parameters(&self) -> Result<&PrestoParameters, &Self>

Tries to convert the enum instance into PrestoParameters, extracting the inner PrestoParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_presto_parameters(&self) -> bool

Returns true if this is a PrestoParameters.

Source

pub fn as_rds_parameters(&self) -> Result<&RdsParameters, &Self>

Tries to convert the enum instance into RdsParameters, extracting the inner RdsParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_rds_parameters(&self) -> bool

Returns true if this is a RdsParameters.

Source

pub fn as_redshift_parameters(&self) -> Result<&RedshiftParameters, &Self>

Tries to convert the enum instance into RedshiftParameters, extracting the inner RedshiftParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_redshift_parameters(&self) -> bool

Returns true if this is a RedshiftParameters.

Source

pub fn as_s3_parameters(&self) -> Result<&S3Parameters, &Self>

Tries to convert the enum instance into S3Parameters, extracting the inner S3Parameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_s3_parameters(&self) -> bool

Returns true if this is a S3Parameters.

Source

pub fn as_service_now_parameters(&self) -> Result<&ServiceNowParameters, &Self>

Tries to convert the enum instance into ServiceNowParameters, extracting the inner ServiceNowParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_service_now_parameters(&self) -> bool

Returns true if this is a ServiceNowParameters.

Source

pub fn as_snowflake_parameters(&self) -> Result<&SnowflakeParameters, &Self>

Tries to convert the enum instance into SnowflakeParameters, extracting the inner SnowflakeParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_snowflake_parameters(&self) -> bool

Returns true if this is a SnowflakeParameters.

Source

pub fn as_spark_parameters(&self) -> Result<&SparkParameters, &Self>

Tries to convert the enum instance into SparkParameters, extracting the inner SparkParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_spark_parameters(&self) -> bool

Returns true if this is a SparkParameters.

Source

pub fn as_sql_server_parameters(&self) -> Result<&SqlServerParameters, &Self>

Tries to convert the enum instance into SqlServerParameters, extracting the inner SqlServerParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_sql_server_parameters(&self) -> bool

Returns true if this is a SqlServerParameters.

Source

pub fn as_starburst_parameters(&self) -> Result<&StarburstParameters, &Self>

Tries to convert the enum instance into StarburstParameters, extracting the inner StarburstParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_starburst_parameters(&self) -> bool

Returns true if this is a StarburstParameters.

Source

pub fn as_teradata_parameters(&self) -> Result<&TeradataParameters, &Self>

Tries to convert the enum instance into TeradataParameters, extracting the inner TeradataParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_teradata_parameters(&self) -> bool

Returns true if this is a TeradataParameters.

Source

pub fn as_trino_parameters(&self) -> Result<&TrinoParameters, &Self>

Tries to convert the enum instance into TrinoParameters, extracting the inner TrinoParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_trino_parameters(&self) -> bool

Returns true if this is a TrinoParameters.

Source

pub fn as_twitter_parameters(&self) -> Result<&TwitterParameters, &Self>

Tries to convert the enum instance into TwitterParameters, extracting the inner TwitterParameters. Returns Err(&Self) if it can’t be converted.

Source

pub fn is_twitter_parameters(&self) -> bool

Returns true if this is a TwitterParameters.

Source

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations§

Source§

impl Clone for DataSourceParameters

Source§

fn clone(&self) -> DataSourceParameters

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 DataSourceParameters

Source§

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

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

impl PartialEq for DataSourceParameters

Source§

fn eq(&self, other: &DataSourceParameters) -> 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 DataSourceParameters

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,