DbInstanceAutomatedBackupBuilder

Struct DbInstanceAutomatedBackupBuilder 

Source
#[non_exhaustive]
pub struct DbInstanceAutomatedBackupBuilder { /* private fields */ }
Expand description

Implementations§

Source§

impl DbInstanceAutomatedBackupBuilder

Source

pub fn db_instance_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) for the automated backups.

Source

pub fn set_db_instance_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) for the automated backups.

Source

pub fn get_db_instance_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) for the automated backups.

Source

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.

Source

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.

Source

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.

Source

pub fn region(self, input: impl Into<String>) -> Self

The Amazon Web Services Region associated with the automated backup.

Source

pub fn set_region(self, input: Option<String>) -> Self

The Amazon Web Services Region associated with the automated backup.

Source

pub fn get_region(&self) -> &Option<String>

The Amazon Web Services Region associated with the automated backup.

Source

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.

Source

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.

Source

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.

Source

pub fn restore_window(self, input: RestoreWindow) -> Self

The earliest and latest time a DB instance can be restored to.

Source

pub fn set_restore_window(self, input: Option<RestoreWindow>) -> Self

The earliest and latest time a DB instance can be restored to.

Source

pub fn get_restore_window(&self) -> &Option<RestoreWindow>

The earliest and latest time a DB instance can be restored to.

Source

pub fn allocated_storage(self, input: i32) -> Self

The allocated storage size for the the automated backup in gibibytes (GiB).

Source

pub fn set_allocated_storage(self, input: Option<i32>) -> Self

The allocated storage size for the the automated backup in gibibytes (GiB).

Source

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

The allocated storage size for the the automated backup in gibibytes (GiB).

Source

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.

Source

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.

Source

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.

Source

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

Source

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

Source

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

Source

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.

Source

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.

Source

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.

Source

pub fn vpc_id(self, input: impl Into<String>) -> Self

The VPC ID associated with the DB instance.

Source

pub fn set_vpc_id(self, input: Option<String>) -> Self

The VPC ID associated with the DB instance.

Source

pub fn get_vpc_id(&self) -> &Option<String>

The VPC ID associated with the DB instance.

Source

pub fn instance_create_time(self, input: DateTime) -> Self

The date and time when the DB instance was created.

Source

pub fn set_instance_create_time(self, input: Option<DateTime>) -> Self

The date and time when the DB instance was created.

Source

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

The date and time when the DB instance was created.

Source

pub fn master_username(self, input: impl Into<String>) -> Self

The master user name of an automated backup.

Source

pub fn set_master_username(self, input: Option<String>) -> Self

The master user name of an automated backup.

Source

pub fn get_master_username(&self) -> &Option<String>

The master user name of an automated backup.

Source

pub fn engine(self, input: impl Into<String>) -> Self

The name of the database engine for this automated backup.

Source

pub fn set_engine(self, input: Option<String>) -> Self

The name of the database engine for this automated backup.

Source

pub fn get_engine(&self) -> &Option<String>

The name of the database engine for this automated backup.

Source

pub fn engine_version(self, input: impl Into<String>) -> Self

The version of the database engine for the automated backup.

Source

pub fn set_engine_version(self, input: Option<String>) -> Self

The version of the database engine for the automated backup.

Source

pub fn get_engine_version(&self) -> &Option<String>

The version of the database engine for the automated backup.

Source

pub fn license_model(self, input: impl Into<String>) -> Self

The license model information for the automated backup.

Source

pub fn set_license_model(self, input: Option<String>) -> Self

The license model information for the automated backup.

Source

pub fn get_license_model(&self) -> &Option<String>

The license model information for the automated backup.

Source

pub fn iops(self, input: i32) -> Self

The IOPS (I/O operations per second) value for the automated backup.

Source

pub fn set_iops(self, input: Option<i32>) -> Self

The IOPS (I/O operations per second) value for the automated backup.

Source

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

The IOPS (I/O operations per second) value for the automated backup.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn encrypted(self, input: bool) -> Self

Indicates whether the automated backup is encrypted.

Source

pub fn set_encrypted(self, input: Option<bool>) -> Self

Indicates whether the automated backup is encrypted.

Source

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

Indicates whether the automated backup is encrypted.

Source

pub fn storage_type(self, input: impl Into<String>) -> Self

The storage type associated with the automated backup.

Source

pub fn set_storage_type(self, input: Option<String>) -> Self

The storage type associated with the automated backup.

Source

pub fn get_storage_type(&self) -> &Option<String>

The storage type associated with the automated backup.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn backup_retention_period(self, input: i32) -> Self

The retention period for the automated backups.

Source

pub fn set_backup_retention_period(self, input: Option<i32>) -> Self

The retention period for the automated backups.

Source

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

The retention period for the automated backups.

Source

pub fn db_instance_automated_backups_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) for the replicated automated backups.

Source

pub fn set_db_instance_automated_backups_arn( self, input: Option<String>, ) -> Self

The Amazon Resource Name (ARN) for the replicated automated backups.

Source

pub fn get_db_instance_automated_backups_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) for the replicated automated backups.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn storage_throughput(self, input: i32) -> Self

The storage throughput for the automated backup.

Source

pub fn set_storage_throughput(self, input: Option<i32>) -> Self

The storage throughput for the automated backup.

Source

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

The storage throughput for the automated backup.

Source

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.

Source

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.

Source

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.

Source

pub fn dedicated_log_volume(self, input: bool) -> Self

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Source

pub fn set_dedicated_log_volume(self, input: Option<bool>) -> Self

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Source

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

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Source

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).

Source

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).

Source

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).

Source

pub fn build(self) -> DbInstanceAutomatedBackup

Consumes the builder and constructs a DbInstanceAutomatedBackup.

Trait Implementations§

Source§

impl Clone for DbInstanceAutomatedBackupBuilder

Source§

fn clone(&self) -> DbInstanceAutomatedBackupBuilder

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 DbInstanceAutomatedBackupBuilder

Source§

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

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

impl Default for DbInstanceAutomatedBackupBuilder

Source§

fn default() -> DbInstanceAutomatedBackupBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for DbInstanceAutomatedBackupBuilder

Source§

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

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,