aws_sdk_securityhub::types

Struct AwsRdsDbInstanceDetails

Source 
#[non_exhaustive]
pub struct AwsRdsDbInstanceDetails {
Show 57 fields
    pub associated_roles: Option<Vec<AwsRdsDbInstanceAssociatedRole>>,
    pub ca_certificate_identifier: Option<String>,
    pub db_cluster_identifier: Option<String>,
    pub db_instance_identifier: Option<String>,
    pub db_instance_class: Option<String>,
    pub db_instance_port: Option<i32>,
    pub dbi_resource_id: Option<String>,
    pub db_name: Option<String>,
    pub deletion_protection: Option<bool>,
    pub endpoint: Option<AwsRdsDbInstanceEndpoint>,
    pub engine: Option<String>,
    pub engine_version: Option<String>,
    pub iam_database_authentication_enabled: Option<bool>,
    pub instance_create_time: Option<String>,
    pub kms_key_id: Option<String>,
    pub publicly_accessible: Option<bool>,
    pub storage_encrypted: Option<bool>,
    pub tde_credential_arn: Option<String>,
    pub vpc_security_groups: Option<Vec<AwsRdsDbInstanceVpcSecurityGroup>>,
    pub multi_az: Option<bool>,
    pub enhanced_monitoring_resource_arn: Option<String>,
    pub db_instance_status: Option<String>,
    pub master_username: Option<String>,
    pub allocated_storage: Option<i32>,
    pub preferred_backup_window: Option<String>,
    pub backup_retention_period: Option<i32>,
    pub db_security_groups: Option<Vec<String>>,
    pub db_parameter_groups: Option<Vec<AwsRdsDbParameterGroup>>,
    pub availability_zone: Option<String>,
    pub db_subnet_group: Option<AwsRdsDbSubnetGroup>,
    pub preferred_maintenance_window: Option<String>,
    pub pending_modified_values: Option<AwsRdsDbPendingModifiedValues>,
    pub latest_restorable_time: Option<String>,
    pub auto_minor_version_upgrade: Option<bool>,
    pub read_replica_source_db_instance_identifier: Option<String>,
    pub read_replica_db_instance_identifiers: Option<Vec<String>>,
    pub read_replica_db_cluster_identifiers: Option<Vec<String>>,
    pub license_model: Option<String>,
    pub iops: Option<i32>,
    pub option_group_memberships: Option<Vec<AwsRdsDbOptionGroupMembership>>,
    pub character_set_name: Option<String>,
    pub secondary_availability_zone: Option<String>,
    pub status_infos: Option<Vec<AwsRdsDbStatusInfo>>,
    pub storage_type: Option<String>,
    pub domain_memberships: Option<Vec<AwsRdsDbDomainMembership>>,
    pub copy_tags_to_snapshot: Option<bool>,
    pub monitoring_interval: Option<i32>,
    pub monitoring_role_arn: Option<String>,
    pub promotion_tier: Option<i32>,
    pub timezone: Option<String>,
    pub performance_insights_enabled: Option<bool>,
    pub performance_insights_kms_key_id: Option<String>,
    pub performance_insights_retention_period: Option<i32>,
    pub enabled_cloud_watch_logs_exports: Option<Vec<String>>,
    pub processor_features: Option<Vec<AwsRdsDbProcessorFeature>>,
    pub listener_endpoint: Option<AwsRdsDbInstanceEndpoint>,
    pub max_allocated_storage: Option<i32>,

}
Expand description

Contains the details of an Amazon RDS DB instance.

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.
§associated_roles: Option<Vec<AwsRdsDbInstanceAssociatedRole>>

The IAM roles associated with the DB instance.

§ca_certificate_identifier: Option<String>

The identifier of the CA certificate for this DB instance.

§db_cluster_identifier: Option<String>

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

§db_instance_identifier: Option<String>

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

§db_instance_class: Option<String>

Contains the name of the compute and memory capacity class of the DB instance.

§db_instance_port: Option<i32>

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

§dbi_resource_id: Option<String>

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.

§db_name: Option<String>

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters don't apply to an Oracle DB instance.

§deletion_protection: Option<bool>

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.

§endpoint: Option<AwsRdsDbInstanceEndpoint>

Specifies the connection endpoint.

§engine: Option<String>

Provides the name of the database engine to use for this DB instance.

§engine_version: Option<String>

Indicates the database engine version.

§iam_database_authentication_enabled: Option<bool>

True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines.

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher

§instance_create_time: Option<String>

Indicates when the DB instance was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

§kms_key_id: Option<String>

If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

§publicly_accessible: Option<bool>

Specifies the accessibility options for the DB instance.

A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

§storage_encrypted: Option<bool>

Specifies whether the DB instance is encrypted.

§tde_credential_arn: Option<String>

The ARN from the key store with which the instance is associated for TDE encryption.

§vpc_security_groups: Option<Vec<AwsRdsDbInstanceVpcSecurityGroup>>

A list of VPC security groups that the DB instance belongs to.

§multi_az: Option<bool>

Whether the DB instance is a multiple Availability Zone deployment.

§enhanced_monitoring_resource_arn: Option<String>

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

§db_instance_status: Option<String>

The current status of the DB instance.

§master_username: Option<String>

The master user name of the DB instance.

§allocated_storage: Option<i32>

The amount of storage (in gigabytes) to initially allocate for the DB instance.

§preferred_backup_window: Option<String>

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

§backup_retention_period: Option<i32>

The number of days for which to retain automated backups.

§db_security_groups: Option<Vec<String>>

A list of the DB security groups to assign to the DB instance.

§db_parameter_groups: Option<Vec<AwsRdsDbParameterGroup>>

A list of the DB parameter groups to assign to the DB instance.

§availability_zone: Option<String>

The Availability Zone where the DB instance will be created.

§db_subnet_group: Option<AwsRdsDbSubnetGroup>

Information about the subnet group that is associated with the DB instance.

§preferred_maintenance_window: Option<String>

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Uses the format :HH:MM- :HH:MM .

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

§pending_modified_values: Option<AwsRdsDbPendingModifiedValues>

Changes to the DB instance that are currently pending.

§latest_restorable_time: Option<String>

Specifies the latest time to which a database can be restored with point-in-time restore.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

§auto_minor_version_upgrade: Option<bool>

Indicates whether minor version patches are applied automatically.

§read_replica_source_db_instance_identifier: Option<String>

If this DB instance is a read replica, contains the identifier of the source DB instance.

§read_replica_db_instance_identifiers: Option<Vec<String>>

List of identifiers of the read replicas associated with this DB instance.

§read_replica_db_cluster_identifiers: Option<Vec<String>>

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

§license_model: Option<String>

License model information for this DB instance.

§iops: Option<i32>

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

§option_group_memberships: Option<Vec<AwsRdsDbOptionGroupMembership>>

The list of option group memberships for this DB instance.

§character_set_name: Option<String>

The name of the character set that this DB instance is associated with.

§secondary_availability_zone: Option<String>

For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

§status_infos: Option<Vec<AwsRdsDbStatusInfo>>

The status of a read replica. If the instance isn't a read replica, this is empty.

§storage_type: Option<String>

The storage type for the DB instance.

§domain_memberships: Option<Vec<AwsRdsDbDomainMembership>>

The Active Directory domain membership records associated with the DB instance.

§copy_tags_to_snapshot: Option<bool>

Whether to copy resource tags to snapshots of the DB instance.

§monitoring_interval: Option<i32>

The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

§monitoring_role_arn: Option<String>

The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

§promotion_tier: Option<i32>

The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

§timezone: Option<String>

The time zone of the DB instance.

§performance_insights_enabled: Option<bool>

Indicates whether Performance Insights is enabled for the DB instance.

§performance_insights_kms_key_id: Option<String>

The identifier of the KMS key used to encrypt the Performance Insights data.

§performance_insights_retention_period: Option<i32>

The number of days to retain Performance Insights data.

§enabled_cloud_watch_logs_exports: Option<Vec<String>>

A list of log types that this DB instance is configured to export to CloudWatch Logs.

§processor_features: Option<Vec<AwsRdsDbProcessorFeature>>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

§listener_endpoint: Option<AwsRdsDbInstanceEndpoint>

Specifies the connection endpoint.

§max_allocated_storage: Option<i32>

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Implementations§

Source§

impl AwsRdsDbInstanceDetails

Source

pub fn associated_roles(&self) -> &[AwsRdsDbInstanceAssociatedRole]

The IAM roles associated with the DB instance.

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

Source

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

The identifier of the CA certificate for this DB instance.

Source

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

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Source

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

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Source

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

Contains the name of the compute and memory capacity class of the DB instance.

Source

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

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

Source

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

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.

Source

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

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters don't apply to an Oracle DB instance.

Source

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

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.

Source

pub fn endpoint(&self) -> Option<&AwsRdsDbInstanceEndpoint>

Specifies the connection endpoint.

Source

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

Provides the name of the database engine to use for this DB instance.

Source

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

Indicates the database engine version.

Source

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

True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines.

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher

Source

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

Indicates when the DB instance was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

Source

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

Specifies the accessibility options for the DB instance.

A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Source

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

Specifies whether the DB instance is encrypted.

Source

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

The ARN from the key store with which the instance is associated for TDE encryption.

Source

pub fn vpc_security_groups(&self) -> &[AwsRdsDbInstanceVpcSecurityGroup]

A list of VPC security groups that the DB instance belongs 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 .vpc_security_groups.is_none().

Source

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

Whether the DB instance is a multiple Availability Zone deployment.

Source

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

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

Source

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

The current status of the DB instance.

Source

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

The master user name of the DB instance.

Source

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

The amount of storage (in gigabytes) to initially allocate for the DB instance.

Source

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

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

Source

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

The number of days for which to retain automated backups.

Source

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

A list of the DB security groups to assign to the DB instance.

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

Source

pub fn db_parameter_groups(&self) -> &[AwsRdsDbParameterGroup]

A list of the DB parameter groups to assign to the DB instance.

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

Source

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

The Availability Zone where the DB instance will be created.

Source

pub fn db_subnet_group(&self) -> Option<&AwsRdsDbSubnetGroup>

Information about the subnet group that is associated with the DB instance.

Source

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

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Uses the format :HH:MM- :HH:MM .

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

Source

pub fn pending_modified_values(&self) -> Option<&AwsRdsDbPendingModifiedValues>

Changes to the DB instance that are currently pending.

Source

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

Specifies the latest time to which a database can be restored with point-in-time restore.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

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

Indicates whether minor version patches are applied automatically.

Source

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

If this DB instance is a read replica, contains the identifier of the source DB instance.

Source

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

List of identifiers of the read replicas associated with this DB instance.

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

Source

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

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

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

Source

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

License model information for this DB instance.

Source

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

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

Source

pub fn option_group_memberships(&self) -> &[AwsRdsDbOptionGroupMembership]

The list of option group memberships for this DB instance.

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

Source

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

The name of the character set that this DB instance is associated with.

Source

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

For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

Source

pub fn status_infos(&self) -> &[AwsRdsDbStatusInfo]

The status of a read replica. If the instance isn't a read replica, this is empty.

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

Source

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

The storage type for the DB instance.

Source

pub fn domain_memberships(&self) -> &[AwsRdsDbDomainMembership]

The Active Directory domain membership records associated with the DB instance.

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

Source

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

Whether to copy resource tags to snapshots of the DB instance.

Source

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

The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

Source

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

The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

Source

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

The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

Source

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

The time zone of the DB instance.

Source

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

Indicates whether Performance Insights is enabled for the DB instance.

Source

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

The identifier of the KMS key used to encrypt the Performance Insights data.

Source

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

The number of days to retain Performance Insights data.

Source

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

A list of log types that this DB instance is configured to 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 .enabled_cloud_watch_logs_exports.is_none().

Source

pub fn processor_features(&self) -> &[AwsRdsDbProcessorFeature]

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

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

Source

pub fn listener_endpoint(&self) -> Option<&AwsRdsDbInstanceEndpoint>

Specifies the connection endpoint.

Source

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

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Source§

impl AwsRdsDbInstanceDetails

Source

pub fn builder() -> AwsRdsDbInstanceDetailsBuilder

Creates a new builder-style object to manufacture AwsRdsDbInstanceDetails.

Trait Implementations§

Source§

impl Clone for AwsRdsDbInstanceDetails

Source§

fn clone(&self) -> AwsRdsDbInstanceDetails

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AwsRdsDbInstanceDetails

Source§

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

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

impl PartialEq for AwsRdsDbInstanceDetails

Source§

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

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

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 AwsRdsDbInstanceDetails

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,