DbInstanceBuilder

aws_sdk_docdb::types::builders

Struct DbInstanceBuilder 

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

A builder for DbInstance.

Implementations§

Source§

impl DbInstanceBuilder

Source

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Source

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Source

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Source

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

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

Source

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

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

Source

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

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

Source

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

Provides the name of the database engine to be used for this instance.

Source

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

Provides the name of the database engine to be used for this instance.

Source

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

Provides the name of the database engine to be used for this instance.

Source

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

Specifies the current state of this database.

Source

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

Specifies the current state of this database.

Source

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

Specifies the current state of this database.

Source

pub fn endpoint(self, input: Endpoint) -> Self

Specifies the connection endpoint.

Source

pub fn set_endpoint(self, input: Option<Endpoint>) -> Self

Specifies the connection endpoint.

Source

pub fn get_endpoint(&self) -> &Option<Endpoint>

Specifies the connection endpoint.

Source

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

Provides the date and time that the instance was created.

Source

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

Provides the date and time that the instance was created.

Source

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

Provides the date and time that the instance was created.

Source

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

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Source

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

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Source

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

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Source

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

Specifies the number of days for which automatic snapshots are retained.

Source

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

Specifies the number of days for which automatic snapshots are retained.

Source

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

Specifies the number of days for which automatic snapshots are retained.

Source

pub fn vpc_security_groups(self, input: VpcSecurityGroupMembership) -> Self

Appends an item to vpc_security_groups.

To override the contents of this collection use set_vpc_security_groups.

Provides a list of VPC security group elements that the instance belongs to.

Source

pub fn set_vpc_security_groups( self, input: Option<Vec<VpcSecurityGroupMembership>>, ) -> Self

Provides a list of VPC security group elements that the instance belongs to.

Source

pub fn get_vpc_security_groups( &self, ) -> &Option<Vec<VpcSecurityGroupMembership>>

Provides a list of VPC security group elements that the instance belongs to.

Source

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

Specifies the name of the Availability Zone that the instance is located in.

Source

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

Specifies the name of the Availability Zone that the instance is located in.

Source

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

Specifies the name of the Availability Zone that the instance is located in.

Source

pub fn db_subnet_group(self, input: DbSubnetGroup) -> Self

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

Source

pub fn set_db_subnet_group(self, input: Option<DbSubnetGroup>) -> Self

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

Source

pub fn get_db_subnet_group(&self) -> &Option<DbSubnetGroup>

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

Source

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

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

Source

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

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

Source

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

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

Source

pub fn pending_modified_values(self, input: PendingModifiedValues) -> Self

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

Source

pub fn set_pending_modified_values( self, input: Option<PendingModifiedValues>, ) -> Self

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

Source

pub fn get_pending_modified_values(&self) -> &Option<PendingModifiedValues>

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

Source

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

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

Source

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

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

Source

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

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

Source

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

Indicates the database engine version.

Source

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

Indicates the database engine version.

Source

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

Indicates the database engine version.

Source

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

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Source

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

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Source

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

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Source

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

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

Source

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

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

Source

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

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

Source

pub fn status_infos(self, input: DbInstanceStatusInfo) -> Self

Appends an item to status_infos.

To override the contents of this collection use set_status_infos.

The status of a read replica. If the instance is not a read replica, this is blank.

Source

pub fn set_status_infos(self, input: Option<Vec<DbInstanceStatusInfo>>) -> Self

The status of a read replica. If the instance is not a read replica, this is blank.

Source

pub fn get_status_infos(&self) -> &Option<Vec<DbInstanceStatusInfo>>

The status of a read replica. If the instance is not a read replica, this is blank.

Source

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Source

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Source

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Source

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

Specifies whether or not the instance is encrypted.

Source

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

Specifies whether or not the instance is encrypted.

Source

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

Specifies whether or not the instance is encrypted.

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

The identifier of the CA certificate for this DB instance.

Source

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

The identifier of the CA certificate for this DB instance.

Source

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

The identifier of the CA certificate for this DB instance.

Source

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

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Source

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

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Source

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

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Source

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Source

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Source

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Source

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

The Amazon Resource Name (ARN) for the instance.

Source

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

The Amazon Resource Name (ARN) for the instance.

Source

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

The Amazon Resource Name (ARN) for the instance.

Source

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

Appends an item to enabled_cloudwatch_logs_exports.

To override the contents of this collection use set_enabled_cloudwatch_logs_exports.

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

Source

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

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

Source

pub fn get_enabled_cloudwatch_logs_exports(&self) -> &Option<Vec<String>>

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

Source

pub fn certificate_details(self, input: CertificateDetails) -> Self

The details of the DB instance's server certificate.

Source

pub fn set_certificate_details(self, input: Option<CertificateDetails>) -> Self

The details of the DB instance's server certificate.

Source

pub fn get_certificate_details(&self) -> &Option<CertificateDetails>

The details of the DB instance's server certificate.

Source

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

Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

Source

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

Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

Source

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

Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

Source

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

The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Source

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

The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Source

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

The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Source

pub fn build(self) -> DbInstance

Consumes the builder and constructs a DbInstance.

Trait Implementations§

Source§

impl Clone for DbInstanceBuilder

Source§

fn clone(&self) -> DbInstanceBuilder

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 DbInstanceBuilder

Source§

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

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

impl Default for DbInstanceBuilder

Source§

fn default() -> DbInstanceBuilder

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

impl PartialEq for DbInstanceBuilder

Source§

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

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,