aws_sdk_rds::operation::create_custom_db_engine_version

Struct CreateCustomDbEngineVersionOutput

Source 
#[non_exhaustive]
pub struct CreateCustomDbEngineVersionOutput {
Show 35 fields
    pub engine: Option<String>,
    pub engine_version: Option<String>,
    pub db_parameter_group_family: Option<String>,
    pub db_engine_description: Option<String>,
    pub db_engine_version_description: Option<String>,
    pub default_character_set: Option<CharacterSet>,
    pub image: Option<CustomDbEngineVersionAmi>,
    pub db_engine_media_type: Option<String>,
    pub supported_character_sets: Option<Vec<CharacterSet>>,
    pub supported_nchar_character_sets: Option<Vec<CharacterSet>>,
    pub valid_upgrade_target: Option<Vec<UpgradeTarget>>,
    pub supported_timezones: Option<Vec<Timezone>>,
    pub exportable_log_types: Option<Vec<String>>,
    pub supports_log_exports_to_cloudwatch_logs: Option<bool>,
    pub supports_read_replica: Option<bool>,
    pub supported_engine_modes: Option<Vec<String>>,
    pub supported_feature_names: Option<Vec<String>>,
    pub status: Option<String>,
    pub supports_parallel_query: Option<bool>,
    pub supports_global_databases: Option<bool>,
    pub major_engine_version: Option<String>,
    pub database_installation_files_s3_bucket_name: Option<String>,
    pub database_installation_files_s3_prefix: Option<String>,
    pub db_engine_version_arn: Option<String>,
    pub kms_key_id: Option<String>,
    pub create_time: Option<DateTime>,
    pub tag_list: Option<Vec<Tag>>,
    pub supports_babelfish: Option<bool>,
    pub custom_db_engine_version_manifest: Option<String>,
    pub supports_limitless_database: Option<bool>,
    pub supports_certificate_rotation_without_restart: Option<bool>,
    pub supported_ca_certificate_identifiers: Option<Vec<String>>,
    pub supports_local_write_forwarding: Option<bool>,
    pub supports_integrations: Option<bool>,
    pub serverless_v2_features_support: Option<ServerlessV2FeaturesSupport>,
    /* private fields */

}
Expand description

This data type is used as a response element in the action DescribeDBEngineVersions.

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.
§engine: Option<String>

The name of the database engine.

§engine_version: Option<String>

The version number of the database engine.

§db_parameter_group_family: Option<String>

The name of the DB parameter group family for the database engine.

§db_engine_description: Option<String>

The description of the database engine.

§db_engine_version_description: Option<String>

The description of the database engine version.

§default_character_set: Option<CharacterSet>

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

§image: Option<CustomDbEngineVersionAmi>

The EC2 image

§db_engine_media_type: Option<String>

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

§supported_character_sets: Option<Vec<CharacterSet>>

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

§supported_nchar_character_sets: Option<Vec<CharacterSet>>

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

§valid_upgrade_target: Option<Vec<UpgradeTarget>>

A list of engine versions that this database engine version can be upgraded to.

§supported_timezones: Option<Vec<Timezone>>

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

§exportable_log_types: Option<Vec<String>>

The types of logs that the database engine has available for export to CloudWatch Logs.

§supports_log_exports_to_cloudwatch_logs: Option<bool>

Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

§supports_read_replica: Option<bool>

Indicates whether the database engine version supports read replicas.

§supported_engine_modes: Option<Vec<String>>

A list of the supported DB engine modes.

§supported_feature_names: Option<Vec<String>>

A list of features supported by the DB engine.

The supported features vary by DB engine and DB engine version.

To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

aws rds describe-db-engine-versions --engine --engine-version

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

The supported features are listed under SupportedFeatureNames in the output.

§status: Option<String>

The status of the DB engine version, either available or deprecated.

§supports_parallel_query: Option<bool>

Indicates whether you can use Aurora parallel query with a specific DB engine version.

§supports_global_databases: Option<bool>

Indicates whether you can use Aurora global databases with a specific DB engine version.

§major_engine_version: Option<String>

The major engine version of the CEV.

§database_installation_files_s3_bucket_name: Option<String>

The name of the Amazon S3 bucket that contains your database installation files.

§database_installation_files_s3_prefix: Option<String>

The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

§db_engine_version_arn: Option<String>

The ARN of the custom engine version.

§kms_key_id: Option<String>

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

§create_time: Option<DateTime>

The creation time of the DB engine version.

§tag_list: Option<Vec<Tag>>

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

§supports_babelfish: Option<bool>

Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

§custom_db_engine_version_manifest: Option<String>

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

§supports_limitless_database: Option<bool>

Indicates whether the DB engine version supports Aurora Limitless Database.

§supports_certificate_rotation_without_restart: Option<bool>

Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

§supported_ca_certificate_identifiers: Option<Vec<String>>

A list of the supported CA certificate identifiers.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

§supports_local_write_forwarding: Option<bool>

Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

Valid for: Aurora DB clusters only

§supports_integrations: Option<bool>

Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

§serverless_v2_features_support: Option<ServerlessV2FeaturesSupport>

Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.

Implementations§

Source§

impl CreateCustomDbEngineVersionOutput

Source

pub fn engine(&self) -> Option<&str>

The name of the database engine.

Source

pub fn engine_version(&self) -> Option<&str>

The version number of the database engine.

Source

pub fn db_parameter_group_family(&self) -> Option<&str>

The name of the DB parameter group family for the database engine.

Source

pub fn db_engine_description(&self) -> Option<&str>

The description of the database engine.

Source

pub fn db_engine_version_description(&self) -> Option<&str>

The description of the database engine version.

Source

pub fn default_character_set(&self) -> Option<&CharacterSet>

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

Source

pub fn image(&self) -> Option<&CustomDbEngineVersionAmi>

The EC2 image

Source

pub fn db_engine_media_type(&self) -> Option<&str>

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

Source

pub fn supported_character_sets(&self) -> &[CharacterSet]

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

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

Source

pub fn supported_nchar_character_sets(&self) -> &[CharacterSet]

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

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

Source

pub fn valid_upgrade_target(&self) -> &[UpgradeTarget]

A list of engine versions that this database engine version can be upgraded to.

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

Source

pub fn supported_timezones(&self) -> &[Timezone]

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

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

Source

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

The types of logs that the database engine has available for export to CloudWatch Logs.

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

Source

pub fn supports_log_exports_to_cloudwatch_logs(&self) -> Option<bool>

Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

Source

pub fn supports_read_replica(&self) -> Option<bool>

Indicates whether the database engine version supports read replicas.

Source

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

A list of the supported DB engine modes.

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

Source

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

A list of features supported by the DB engine.

The supported features vary by DB engine and DB engine version.

To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:

aws rds describe-db-engine-versions --engine --engine-version

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:

aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

The supported features are listed under SupportedFeatureNames in the output.

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

Source

pub fn status(&self) -> Option<&str>

The status of the DB engine version, either available or deprecated.

Source

pub fn supports_parallel_query(&self) -> Option<bool>

Indicates whether you can use Aurora parallel query with a specific DB engine version.

Source

pub fn supports_global_databases(&self) -> Option<bool>

Indicates whether you can use Aurora global databases with a specific DB engine version.

Source

pub fn major_engine_version(&self) -> Option<&str>

The major engine version of the CEV.

Source

pub fn database_installation_files_s3_bucket_name(&self) -> Option<&str>

The name of the Amazon S3 bucket that contains your database installation files.

Source

pub fn database_installation_files_s3_prefix(&self) -> Option<&str>

The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

Source

pub fn db_engine_version_arn(&self) -> Option<&str>

The ARN of the custom engine version.

Source

pub fn kms_key_id(&self) -> Option<&str>

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

Source

pub fn create_time(&self) -> Option<&DateTime>

The creation time of the DB engine version.

Source

pub fn tag_list(&self) -> &[Tag]

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

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

Source

pub fn supports_babelfish(&self) -> Option<bool>

Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

Source

pub fn custom_db_engine_version_manifest(&self) -> Option<&str>

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.

Source

pub fn supports_limitless_database(&self) -> Option<bool>

Indicates whether the DB engine version supports Aurora Limitless Database.

Source

pub fn supports_certificate_rotation_without_restart(&self) -> Option<bool>

Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

Source

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

A list of the supported CA certificate identifiers.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

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

Source

pub fn supports_local_write_forwarding(&self) -> Option<bool>

Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

Valid for: Aurora DB clusters only

Source

pub fn supports_integrations(&self) -> Option<bool>

Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

Source

pub fn serverless_v2_features_support( &self, ) -> Option<&ServerlessV2FeaturesSupport>

Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.

Source§

impl CreateCustomDbEngineVersionOutput

Source

pub fn builder() -> CreateCustomDbEngineVersionOutputBuilder

Creates a new builder-style object to manufacture CreateCustomDbEngineVersionOutput.

Trait Implementations§

Source§

impl Clone for CreateCustomDbEngineVersionOutput

Source§

fn clone(&self) -> CreateCustomDbEngineVersionOutput

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 CreateCustomDbEngineVersionOutput

Source§

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

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

impl PartialEq for CreateCustomDbEngineVersionOutput

Source§

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

Source§

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.
Source§

impl StructuralPartialEq for CreateCustomDbEngineVersionOutput

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,