DbSnapshotBuilder

aws_sdk_rds::types::builders

Struct DbSnapshotBuilder 

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

A builder for DbSnapshot.

Implementations§

Source§

impl DbSnapshotBuilder

Source

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

Specifies the identifier for the DB snapshot.

Source

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

Specifies the identifier for the DB snapshot.

Source

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

Specifies the identifier for the DB snapshot.

Source

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

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Source

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

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Source

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

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Source

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

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

Source

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

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

Source

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

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

Source

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

Specifies the name of the database engine.

Source

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

Specifies the name of the database engine.

Source

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

Specifies the name of the database engine.

Source

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

Specifies the allocated storage size in gibibytes (GiB).

Source

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

Specifies the allocated storage size in gibibytes (GiB).

Source

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

Specifies the allocated storage size in gibibytes (GiB).

Source

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

Specifies the status of this DB snapshot.

Source

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

Specifies the status of this DB snapshot.

Source

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

Specifies the status of this DB snapshot.

Source

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

Specifies the port that the database engine was listening on at the time of the snapshot.

Source

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

Specifies the port that the database engine was listening on at the time of the snapshot.

Source

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

Specifies the port that the database engine was listening on at the time of the snapshot.

Source

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

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Source

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

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Source

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

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Source

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

Provides the VPC ID associated with the DB snapshot.

Source

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

Provides the VPC ID associated with the DB snapshot.

Source

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

Provides the VPC ID associated with the DB snapshot.

Source

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

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Source

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

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Source

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

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Source

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

Provides the master username for the DB snapshot.

Source

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

Provides the master username for the DB snapshot.

Source

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

Provides the master username for the DB snapshot.

Source

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

Specifies the version of the database engine.

Source

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

Specifies the version of the database engine.

Source

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

Specifies the version of the database engine.

Source

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

License model information for the restored DB instance.

Source

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

License model information for the restored DB instance.

Source

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

License model information for the restored DB instance.

Source

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

Provides the type of the DB snapshot.

Source

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

Provides the type of the DB snapshot.

Source

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

Provides the type of the DB snapshot.

Source

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

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Source

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

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Source

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

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Source

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

Provides the option group name for the DB snapshot.

Source

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

Provides the option group name for the DB snapshot.

Source

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

Provides the option group name for the DB snapshot.

Source

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

The percentage of the estimated data that has been transferred.

Source

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

The percentage of the estimated data that has been transferred.

Source

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

The percentage of the estimated data that has been transferred.

Source

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

The Amazon Web Services Region that the DB snapshot was created in or copied from.

Source

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

The Amazon Web Services Region that the DB snapshot was created in or copied from.

Source

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

The Amazon Web Services Region that the DB snapshot was created in or copied from.

Source

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

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

Source

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

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

Source

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

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

Source

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

Specifies the storage type associated with DB snapshot.

Source

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

Specifies the storage type associated with DB snapshot.

Source

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

Specifies the storage type associated with DB snapshot.

Source

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

The ARN from the key store with which to associate the instance for TDE encryption.

Source

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

The ARN from the key store with which to associate the instance for TDE encryption.

Source

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

The ARN from the key store with which to associate the instance for TDE encryption.

Source

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

Indicates whether the DB snapshot is encrypted.

Source

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

Indicates whether the DB snapshot is encrypted.

Source

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

Indicates whether the DB snapshot is encrypted.

Source

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

If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

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

If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

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>

If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

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 db_snapshot_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) for the DB snapshot.

Source

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

The Amazon Resource Name (ARN) for the DB snapshot.

Source

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

The Amazon Resource Name (ARN) for the DB snapshot.

Source

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

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from 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 DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from 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 DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Source

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

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Source

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

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Source

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

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Source

pub fn processor_features(self, input: ProcessorFeature) -> Self

Appends an item to processor_features.

To override the contents of this collection use set_processor_features.

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Source

pub fn set_processor_features( self, input: Option<Vec<ProcessorFeature>>, ) -> Self

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Source

pub fn get_processor_features(&self) -> &Option<Vec<ProcessorFeature>>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Source

pub fn dbi_resource_id(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_dbi_resource_id(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_dbi_resource_id(&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 tag_list(self, input: Tag) -> Self

Appends an item to tag_list.

To override the contents of this collection use set_tag_list.

A list of tags.

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

Source

pub fn set_tag_list(self, input: Option<Vec<Tag>>) -> Self

A list of tags.

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

Source

pub fn get_tag_list(&self) -> &Option<Vec<Tag>>

A list of tags.

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

Source

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

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

Source

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

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

Source

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

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

Source

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

The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

Source

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

The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

Source

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

The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

Source

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

Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

Source

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

Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

Source

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

Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

Source

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

Specifies the storage throughput for the DB snapshot.

Source

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

Specifies the storage throughput for the DB snapshot.

Source

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

Specifies the storage throughput for the DB snapshot.

Source

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

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

Source

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

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

Source

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

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

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

Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Source

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

Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Source

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

Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Source

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

Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.

Source

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

Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.

Source

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

Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone.

Source

pub fn build(self) -> DbSnapshot

Consumes the builder and constructs a DbSnapshot.

Trait Implementations§

Source§

impl Clone for DbSnapshotBuilder

Source§

fn clone(&self) -> DbSnapshotBuilder

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 DbSnapshotBuilder

Source§

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

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

impl Default for DbSnapshotBuilder

Source§

fn default() -> DbSnapshotBuilder

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

impl PartialEq for DbSnapshotBuilder

Source§

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

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,