#[non_exhaustive]pub struct DbInstanceAutomatedBackupBuilder { /* private fields */ }
Expand description
A builder for DbInstanceAutomatedBackup
.
Implementations§
Source§impl DbInstanceAutomatedBackupBuilder
impl DbInstanceAutomatedBackupBuilder
Sourcepub fn db_instance_arn(self, input: impl Into<String>) -> Self
pub fn db_instance_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the automated backups.
Sourcepub fn set_db_instance_arn(self, input: Option<String>) -> Self
pub fn set_db_instance_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the automated backups.
Sourcepub fn get_db_instance_arn(&self) -> &Option<String>
pub fn get_db_instance_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the automated backups.
Sourcepub fn dbi_resource_id(self, input: impl Into<String>) -> Self
pub fn dbi_resource_id(self, input: impl Into<String>) -> Self
The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Sourcepub fn set_dbi_resource_id(self, input: Option<String>) -> Self
pub fn set_dbi_resource_id(self, input: Option<String>) -> Self
The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Sourcepub fn get_dbi_resource_id(&self) -> &Option<String>
pub fn get_dbi_resource_id(&self) -> &Option<String>
The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Sourcepub fn region(self, input: impl Into<String>) -> Self
pub fn region(self, input: impl Into<String>) -> Self
The Amazon Web Services Region associated with the automated backup.
Sourcepub fn set_region(self, input: Option<String>) -> Self
pub fn set_region(self, input: Option<String>) -> Self
The Amazon Web Services Region associated with the automated backup.
Sourcepub fn get_region(&self) -> &Option<String>
pub fn get_region(&self) -> &Option<String>
The Amazon Web Services Region associated with the automated backup.
Sourcepub fn db_instance_identifier(self, input: impl Into<String>) -> Self
pub fn db_instance_identifier(self, input: impl Into<String>) -> Self
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Sourcepub fn set_db_instance_identifier(self, input: Option<String>) -> Self
pub fn set_db_instance_identifier(self, input: Option<String>) -> Self
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Sourcepub fn get_db_instance_identifier(&self) -> &Option<String>
pub fn get_db_instance_identifier(&self) -> &Option<String>
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Sourcepub fn restore_window(self, input: RestoreWindow) -> Self
pub fn restore_window(self, input: RestoreWindow) -> Self
The earliest and latest time a DB instance can be restored to.
Sourcepub fn set_restore_window(self, input: Option<RestoreWindow>) -> Self
pub fn set_restore_window(self, input: Option<RestoreWindow>) -> Self
The earliest and latest time a DB instance can be restored to.
Sourcepub fn get_restore_window(&self) -> &Option<RestoreWindow>
pub fn get_restore_window(&self) -> &Option<RestoreWindow>
The earliest and latest time a DB instance can be restored to.
Sourcepub fn allocated_storage(self, input: i32) -> Self
pub fn allocated_storage(self, input: i32) -> Self
The allocated storage size for the the automated backup in gibibytes (GiB).
Sourcepub fn set_allocated_storage(self, input: Option<i32>) -> Self
pub fn set_allocated_storage(self, input: Option<i32>) -> Self
The allocated storage size for the the automated backup in gibibytes (GiB).
Sourcepub fn get_allocated_storage(&self) -> &Option<i32>
pub fn get_allocated_storage(&self) -> &Option<i32>
The allocated storage size for the the automated backup in gibibytes (GiB).
Sourcepub fn status(self, input: impl Into<String>) -> Self
pub fn status(self, input: impl Into<String>) -> Self
A list of status information for an automated backup:
-
active
- Automated backups for current instances. -
retained
- Automated backups for deleted instances. -
creating
- Automated backups that are waiting for the first automated snapshot to be available.
Sourcepub fn set_status(self, input: Option<String>) -> Self
pub fn set_status(self, input: Option<String>) -> Self
A list of status information for an automated backup:
-
active
- Automated backups for current instances. -
retained
- Automated backups for deleted instances. -
creating
- Automated backups that are waiting for the first automated snapshot to be available.
Sourcepub fn get_status(&self) -> &Option<String>
pub fn get_status(&self) -> &Option<String>
A list of status information for an automated backup:
-
active
- Automated backups for current instances. -
retained
- Automated backups for deleted instances. -
creating
- Automated backups that are waiting for the first automated snapshot to be available.
Sourcepub fn port(self, input: i32) -> Self
pub fn port(self, input: i32) -> Self
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
Sourcepub fn set_port(self, input: Option<i32>) -> Self
pub fn set_port(self, input: Option<i32>) -> Self
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
Sourcepub fn get_port(&self) -> &Option<i32>
pub fn get_port(&self) -> &Option<i32>
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
Sourcepub fn availability_zone(self, input: impl Into<String>) -> Self
pub fn availability_zone(self, input: impl Into<String>) -> Self
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
Sourcepub fn set_availability_zone(self, input: Option<String>) -> Self
pub fn set_availability_zone(self, input: Option<String>) -> Self
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
Sourcepub fn get_availability_zone(&self) -> &Option<String>
pub fn get_availability_zone(&self) -> &Option<String>
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
Sourcepub fn vpc_id(self, input: impl Into<String>) -> Self
pub fn vpc_id(self, input: impl Into<String>) -> Self
The VPC ID associated with the DB instance.
Sourcepub fn set_vpc_id(self, input: Option<String>) -> Self
pub fn set_vpc_id(self, input: Option<String>) -> Self
The VPC ID associated with the DB instance.
Sourcepub fn get_vpc_id(&self) -> &Option<String>
pub fn get_vpc_id(&self) -> &Option<String>
The VPC ID associated with the DB instance.
Sourcepub fn instance_create_time(self, input: DateTime) -> Self
pub fn instance_create_time(self, input: DateTime) -> Self
The date and time when the DB instance was created.
Sourcepub fn set_instance_create_time(self, input: Option<DateTime>) -> Self
pub fn set_instance_create_time(self, input: Option<DateTime>) -> Self
The date and time when the DB instance was created.
Sourcepub fn get_instance_create_time(&self) -> &Option<DateTime>
pub fn get_instance_create_time(&self) -> &Option<DateTime>
The date and time when the DB instance was created.
Sourcepub fn master_username(self, input: impl Into<String>) -> Self
pub fn master_username(self, input: impl Into<String>) -> Self
The master user name of an automated backup.
Sourcepub fn set_master_username(self, input: Option<String>) -> Self
pub fn set_master_username(self, input: Option<String>) -> Self
The master user name of an automated backup.
Sourcepub fn get_master_username(&self) -> &Option<String>
pub fn get_master_username(&self) -> &Option<String>
The master user name of an automated backup.
Sourcepub fn engine(self, input: impl Into<String>) -> Self
pub fn engine(self, input: impl Into<String>) -> Self
The name of the database engine for this automated backup.
Sourcepub fn set_engine(self, input: Option<String>) -> Self
pub fn set_engine(self, input: Option<String>) -> Self
The name of the database engine for this automated backup.
Sourcepub fn get_engine(&self) -> &Option<String>
pub fn get_engine(&self) -> &Option<String>
The name of the database engine for this automated backup.
Sourcepub fn engine_version(self, input: impl Into<String>) -> Self
pub fn engine_version(self, input: impl Into<String>) -> Self
The version of the database engine for the automated backup.
Sourcepub fn set_engine_version(self, input: Option<String>) -> Self
pub fn set_engine_version(self, input: Option<String>) -> Self
The version of the database engine for the automated backup.
Sourcepub fn get_engine_version(&self) -> &Option<String>
pub fn get_engine_version(&self) -> &Option<String>
The version of the database engine for the automated backup.
Sourcepub fn license_model(self, input: impl Into<String>) -> Self
pub fn license_model(self, input: impl Into<String>) -> Self
The license model information for the automated backup.
Sourcepub fn set_license_model(self, input: Option<String>) -> Self
pub fn set_license_model(self, input: Option<String>) -> Self
The license model information for the automated backup.
Sourcepub fn get_license_model(&self) -> &Option<String>
pub fn get_license_model(&self) -> &Option<String>
The license model information for the automated backup.
Sourcepub fn iops(self, input: i32) -> Self
pub fn iops(self, input: i32) -> Self
The IOPS (I/O operations per second) value for the automated backup.
Sourcepub fn set_iops(self, input: Option<i32>) -> Self
pub fn set_iops(self, input: Option<i32>) -> Self
The IOPS (I/O operations per second) value for the automated backup.
Sourcepub fn get_iops(&self) -> &Option<i32>
pub fn get_iops(&self) -> &Option<i32>
The IOPS (I/O operations per second) value for the automated backup.
Sourcepub fn option_group_name(self, input: impl Into<String>) -> Self
pub fn option_group_name(self, input: impl Into<String>) -> Self
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
Sourcepub fn set_option_group_name(self, input: Option<String>) -> Self
pub fn set_option_group_name(self, input: Option<String>) -> Self
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
Sourcepub fn get_option_group_name(&self) -> &Option<String>
pub fn get_option_group_name(&self) -> &Option<String>
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
Sourcepub fn tde_credential_arn(self, input: impl Into<String>) -> Self
pub fn tde_credential_arn(self, input: impl Into<String>) -> Self
The ARN from the key store with which the automated backup is associated for TDE encryption.
Sourcepub fn set_tde_credential_arn(self, input: Option<String>) -> Self
pub fn set_tde_credential_arn(self, input: Option<String>) -> Self
The ARN from the key store with which the automated backup is associated for TDE encryption.
Sourcepub fn get_tde_credential_arn(&self) -> &Option<String>
pub fn get_tde_credential_arn(&self) -> &Option<String>
The ARN from the key store with which the automated backup is associated for TDE encryption.
Sourcepub fn encrypted(self, input: bool) -> Self
pub fn encrypted(self, input: bool) -> Self
Indicates whether the automated backup is encrypted.
Sourcepub fn set_encrypted(self, input: Option<bool>) -> Self
pub fn set_encrypted(self, input: Option<bool>) -> Self
Indicates whether the automated backup is encrypted.
Sourcepub fn get_encrypted(&self) -> &Option<bool>
pub fn get_encrypted(&self) -> &Option<bool>
Indicates whether the automated backup is encrypted.
Sourcepub fn storage_type(self, input: impl Into<String>) -> Self
pub fn storage_type(self, input: impl Into<String>) -> Self
The storage type associated with the automated backup.
Sourcepub fn set_storage_type(self, input: Option<String>) -> Self
pub fn set_storage_type(self, input: Option<String>) -> Self
The storage type associated with the automated backup.
Sourcepub fn get_storage_type(&self) -> &Option<String>
pub fn get_storage_type(&self) -> &Option<String>
The storage type associated with the automated backup.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Sourcepub fn timezone(self, input: impl Into<String>) -> Self
pub fn timezone(self, input: impl Into<String>) -> Self
The time zone of the automated backup. In most cases, the Timezone
element is empty. Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
Sourcepub fn set_timezone(self, input: Option<String>) -> Self
pub fn set_timezone(self, input: Option<String>) -> Self
The time zone of the automated backup. In most cases, the Timezone
element is empty. Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
Sourcepub fn get_timezone(&self) -> &Option<String>
pub fn get_timezone(&self) -> &Option<String>
The time zone of the automated backup. In most cases, the Timezone
element is empty. Timezone
content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
Sourcepub fn iam_database_authentication_enabled(self, input: bool) -> Self
pub fn iam_database_authentication_enabled(self, input: bool) -> Self
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Sourcepub fn set_iam_database_authentication_enabled(
self,
input: Option<bool>,
) -> Self
pub fn set_iam_database_authentication_enabled( self, input: Option<bool>, ) -> Self
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Sourcepub fn get_iam_database_authentication_enabled(&self) -> &Option<bool>
pub fn get_iam_database_authentication_enabled(&self) -> &Option<bool>
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Sourcepub fn backup_retention_period(self, input: i32) -> Self
pub fn backup_retention_period(self, input: i32) -> Self
The retention period for the automated backups.
Sourcepub fn set_backup_retention_period(self, input: Option<i32>) -> Self
pub fn set_backup_retention_period(self, input: Option<i32>) -> Self
The retention period for the automated backups.
Sourcepub fn get_backup_retention_period(&self) -> &Option<i32>
pub fn get_backup_retention_period(&self) -> &Option<i32>
The retention period for the automated backups.
Sourcepub fn db_instance_automated_backups_arn(self, input: impl Into<String>) -> Self
pub fn db_instance_automated_backups_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the replicated automated backups.
Sourcepub fn set_db_instance_automated_backups_arn(
self,
input: Option<String>,
) -> Self
pub fn set_db_instance_automated_backups_arn( self, input: Option<String>, ) -> Self
The Amazon Resource Name (ARN) for the replicated automated backups.
Sourcepub fn get_db_instance_automated_backups_arn(&self) -> &Option<String>
pub fn get_db_instance_automated_backups_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the replicated automated backups.
Sourcepub fn db_instance_automated_backups_replications(
self,
input: DbInstanceAutomatedBackupsReplication,
) -> Self
pub fn db_instance_automated_backups_replications( self, input: DbInstanceAutomatedBackupsReplication, ) -> Self
Appends an item to db_instance_automated_backups_replications
.
To override the contents of this collection use set_db_instance_automated_backups_replications
.
The list of replications to different Amazon Web Services Regions associated with the automated backup.
Sourcepub fn set_db_instance_automated_backups_replications(
self,
input: Option<Vec<DbInstanceAutomatedBackupsReplication>>,
) -> Self
pub fn set_db_instance_automated_backups_replications( self, input: Option<Vec<DbInstanceAutomatedBackupsReplication>>, ) -> Self
The list of replications to different Amazon Web Services Regions associated with the automated backup.
Sourcepub fn get_db_instance_automated_backups_replications(
&self,
) -> &Option<Vec<DbInstanceAutomatedBackupsReplication>>
pub fn get_db_instance_automated_backups_replications( &self, ) -> &Option<Vec<DbInstanceAutomatedBackupsReplication>>
The list of replications to different Amazon Web Services Regions associated with the automated backup.
Sourcepub fn backup_target(self, input: impl Into<String>) -> Self
pub fn backup_target(self, input: impl Into<String>) -> Self
The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
Sourcepub fn set_backup_target(self, input: Option<String>) -> Self
pub fn set_backup_target(self, input: Option<String>) -> Self
The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
Sourcepub fn get_backup_target(&self) -> &Option<String>
pub fn get_backup_target(&self) -> &Option<String>
The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
Sourcepub fn storage_throughput(self, input: i32) -> Self
pub fn storage_throughput(self, input: i32) -> Self
The storage throughput for the automated backup.
Sourcepub fn set_storage_throughput(self, input: Option<i32>) -> Self
pub fn set_storage_throughput(self, input: Option<i32>) -> Self
The storage throughput for the automated backup.
Sourcepub fn get_storage_throughput(&self) -> &Option<i32>
pub fn get_storage_throughput(&self) -> &Option<i32>
The storage throughput for the automated backup.
Sourcepub fn aws_backup_recovery_point_arn(self, input: impl Into<String>) -> Self
pub fn aws_backup_recovery_point_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
Sourcepub fn set_aws_backup_recovery_point_arn(self, input: Option<String>) -> Self
pub fn set_aws_backup_recovery_point_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
Sourcepub fn get_aws_backup_recovery_point_arn(&self) -> &Option<String>
pub fn get_aws_backup_recovery_point_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
Sourcepub fn dedicated_log_volume(self, input: bool) -> Self
pub fn dedicated_log_volume(self, input: bool) -> Self
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
Sourcepub fn set_dedicated_log_volume(self, input: Option<bool>) -> Self
pub fn set_dedicated_log_volume(self, input: Option<bool>) -> Self
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
Sourcepub fn get_dedicated_log_volume(&self) -> &Option<bool>
pub fn get_dedicated_log_volume(&self) -> &Option<bool>
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
Sourcepub fn multi_tenant(self, input: bool) -> Self
pub fn multi_tenant(self, input: bool) -> Self
Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
Sourcepub fn set_multi_tenant(self, input: Option<bool>) -> Self
pub fn set_multi_tenant(self, input: Option<bool>) -> Self
Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
Sourcepub fn get_multi_tenant(&self) -> &Option<bool>
pub fn get_multi_tenant(&self) -> &Option<bool>
Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
Sourcepub fn build(self) -> DbInstanceAutomatedBackup
pub fn build(self) -> DbInstanceAutomatedBackup
Consumes the builder and constructs a DbInstanceAutomatedBackup
.
Trait Implementations§
Source§impl Clone for DbInstanceAutomatedBackupBuilder
impl Clone for DbInstanceAutomatedBackupBuilder
Source§fn clone(&self) -> DbInstanceAutomatedBackupBuilder
fn clone(&self) -> DbInstanceAutomatedBackupBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for DbInstanceAutomatedBackupBuilder
impl Default for DbInstanceAutomatedBackupBuilder
Source§fn default() -> DbInstanceAutomatedBackupBuilder
fn default() -> DbInstanceAutomatedBackupBuilder
Source§impl PartialEq for DbInstanceAutomatedBackupBuilder
impl PartialEq for DbInstanceAutomatedBackupBuilder
Source§fn eq(&self, other: &DbInstanceAutomatedBackupBuilder) -> bool
fn eq(&self, other: &DbInstanceAutomatedBackupBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for DbInstanceAutomatedBackupBuilder
Auto Trait Implementations§
impl Freeze for DbInstanceAutomatedBackupBuilder
impl RefUnwindSafe for DbInstanceAutomatedBackupBuilder
impl Send for DbInstanceAutomatedBackupBuilder
impl Sync for DbInstanceAutomatedBackupBuilder
impl Unpin for DbInstanceAutomatedBackupBuilder
impl UnwindSafe for DbInstanceAutomatedBackupBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);