DbClusterBuilder

aws_sdk_docdb::types::builders

Struct DbClusterBuilder 

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

A builder for DbCluster.

Implementations§

Source§

impl DbClusterBuilder

Source

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

Appends an item to availability_zones.

To override the contents of this collection use set_availability_zones.

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Source

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

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Source

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

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

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

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

Source

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

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

Source

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

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

Source

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

Specifies the name of the cluster parameter group for the cluster.

Source

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

Specifies the name of the cluster parameter group for the cluster.

Source

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

Specifies the name of the cluster parameter group for the cluster.

Source

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

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

Source

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

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

Source

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

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

Source

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

Specifies the current state of this cluster.

Source

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

Specifies the current state of this cluster.

Source

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

Specifies the current state of this cluster.

Source

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

Specifies the progress of the operation as a percentage.

Source

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

Specifies the progress of the operation as a percentage.

Source

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

Specifies the progress of the operation as a percentage.

Source

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

The earliest time to which a database can be restored with point-in-time restore.

Source

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

The earliest time to which a database can be restored with point-in-time restore.

Source

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

The earliest time to which a database can be restored with point-in-time restore.

Source

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

Specifies the connection endpoint for the primary instance of the cluster.

Source

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

Specifies the connection endpoint for the primary instance of the cluster.

Source

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

Specifies the connection endpoint for the primary instance of the cluster.

Source

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

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

Source

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

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

Source

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

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

Source

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

Specifies whether the cluster has instances in multiple Availability Zones.

Source

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

Specifies whether the cluster has instances in multiple Availability Zones.

Source

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

Specifies whether the cluster has instances in multiple Availability Zones.

Source

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

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

Source

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

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

Source

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

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

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 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 port(self, input: i32) -> Self

Specifies the port that the database engine is listening on.

Source

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

Specifies the port that the database engine is listening on.

Source

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

Specifies the port that the database engine is listening on.

Source

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

Contains the master user name for the cluster.

Source

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

Contains the master user name for the cluster.

Source

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

Contains the master user name for the cluster.

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

Contains the identifier of the source cluster if this cluster is a secondary cluster.

Source

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

Contains the identifier of the source cluster if this cluster is a secondary cluster.

Source

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

Contains the identifier of the source cluster if this cluster is a secondary cluster.

Source

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

Appends an item to read_replica_identifiers.

To override the contents of this collection use set_read_replica_identifiers.

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

Source

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

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

Source

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

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

Source

pub fn db_cluster_members(self, input: DbClusterMember) -> Self

Appends an item to db_cluster_members.

To override the contents of this collection use set_db_cluster_members.

Provides the list of instances that make up the cluster.

Source

pub fn set_db_cluster_members(self, input: Option<Vec<DbClusterMember>>) -> Self

Provides the list of instances that make up the cluster.

Source

pub fn get_db_cluster_members(&self) -> &Option<Vec<DbClusterMember>>

Provides the list of instances that make up the cluster.

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 virtual private cloud (VPC) security groups that the cluster belongs to.

Source

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

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Source

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

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Source

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

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Source

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

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Source

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

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Source

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

Specifies whether the cluster is encrypted.

Source

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

Specifies whether the cluster is encrypted.

Source

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

Specifies whether the cluster 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 cluster.

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

The Amazon Resource Name (ARN) for the cluster.

Source

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

The Amazon Resource Name (ARN) for the cluster.

Source

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

The Amazon Resource Name (ARN) for the cluster.

Source

pub fn associated_roles(self, input: DbClusterRole) -> Self

Appends an item to associated_roles.

To override the contents of this collection use set_associated_roles.

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

Source

pub fn set_associated_roles(self, input: Option<Vec<DbClusterRole>>) -> Self

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

Source

pub fn get_associated_roles(&self) -> &Option<Vec<DbClusterRole>>

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

Source

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

Identifies the clone group to which the DB cluster is associated.

Source

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

Identifies the clone group to which the DB cluster is associated.

Source

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

Identifies the clone group to which the DB cluster is associated.

Source

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

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

Source

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

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

Source

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

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

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 cluster is configured to export to Amazon CloudWatch Logs.

Source

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

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

Source

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

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

Source

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

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Source

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

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Source

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

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Source

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

Storage type associated with your cluster

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

Source

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

Storage type associated with your cluster

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

Source

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

Storage type associated with your cluster

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

Source

pub fn serverless_v2_scaling_configuration( self, input: ServerlessV2ScalingConfigurationInfo, ) -> Self

The scaling configuration of an Amazon DocumentDB Serverless cluster.

Source

pub fn set_serverless_v2_scaling_configuration( self, input: Option<ServerlessV2ScalingConfigurationInfo>, ) -> Self

The scaling configuration of an Amazon DocumentDB Serverless cluster.

Source

pub fn get_serverless_v2_scaling_configuration( &self, ) -> &Option<ServerlessV2ScalingConfigurationInfo>

The scaling configuration of an Amazon DocumentDB Serverless cluster.

Source

pub fn master_user_secret(self, input: ClusterMasterUserSecret) -> Self

The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.

Source

pub fn set_master_user_secret( self, input: Option<ClusterMasterUserSecret>, ) -> Self

The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.

Source

pub fn get_master_user_secret(&self) -> &Option<ClusterMasterUserSecret>

The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.

Source

pub fn build(self) -> DbCluster

Consumes the builder and constructs a DbCluster.

Trait Implementations§

Source§

impl Clone for DbClusterBuilder

Source§

fn clone(&self) -> DbClusterBuilder

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 DbClusterBuilder

Source§

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

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

impl Default for DbClusterBuilder

Source§

fn default() -> DbClusterBuilder

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

impl PartialEq for DbClusterBuilder

Source§

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

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,