DbCluster

Struct DbCluster 

Source
#[non_exhaustive]
pub struct DbCluster {
Show 84 fields pub allocated_storage: Option<i32>, pub availability_zones: Option<Vec<String>>, pub backup_retention_period: Option<i32>, pub character_set_name: Option<String>, pub database_name: Option<String>, pub db_cluster_identifier: Option<String>, pub db_cluster_parameter_group: Option<String>, pub db_subnet_group: Option<String>, pub status: Option<String>, pub automatic_restart_time: Option<DateTime>, pub percent_progress: Option<String>, pub earliest_restorable_time: Option<DateTime>, pub endpoint: Option<String>, pub reader_endpoint: Option<String>, pub custom_endpoints: Option<Vec<String>>, pub multi_az: Option<bool>, pub engine: Option<String>, pub engine_version: Option<String>, pub latest_restorable_time: Option<DateTime>, pub port: Option<i32>, pub master_username: Option<String>, pub db_cluster_option_group_memberships: Option<Vec<DbClusterOptionGroupStatus>>, pub preferred_backup_window: Option<String>, pub preferred_maintenance_window: Option<String>, pub replication_source_identifier: Option<String>, pub read_replica_identifiers: Option<Vec<String>>, pub status_infos: Option<Vec<DbClusterStatusInfo>>, pub db_cluster_members: Option<Vec<DbClusterMember>>, pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>, pub hosted_zone_id: Option<String>, pub storage_encrypted: Option<bool>, pub kms_key_id: Option<String>, pub db_cluster_resource_id: Option<String>, pub db_cluster_arn: Option<String>, pub associated_roles: Option<Vec<DbClusterRole>>, pub iam_database_authentication_enabled: Option<bool>, pub clone_group_id: Option<String>, pub cluster_create_time: Option<DateTime>, pub earliest_backtrack_time: Option<DateTime>, pub backtrack_window: Option<i64>, pub backtrack_consumed_change_records: Option<i64>, pub enabled_cloudwatch_logs_exports: Option<Vec<String>>, pub capacity: Option<i32>, pub engine_mode: Option<String>, pub scaling_configuration_info: Option<ScalingConfigurationInfo>, pub rds_custom_cluster_configuration: Option<RdsCustomClusterConfiguration>, pub deletion_protection: Option<bool>, pub http_endpoint_enabled: Option<bool>, pub activity_stream_mode: Option<ActivityStreamMode>, pub activity_stream_status: Option<ActivityStreamStatus>, pub activity_stream_kms_key_id: Option<String>, pub activity_stream_kinesis_stream_name: Option<String>, pub copy_tags_to_snapshot: Option<bool>, pub cross_account_clone: Option<bool>, pub domain_memberships: Option<Vec<DomainMembership>>, pub tag_list: Option<Vec<Tag>>, pub global_cluster_identifier: Option<String>, pub global_write_forwarding_status: Option<WriteForwardingStatus>, pub global_write_forwarding_requested: Option<bool>, pub pending_modified_values: Option<ClusterPendingModifiedValues>, pub db_cluster_instance_class: Option<String>, pub storage_type: Option<String>, pub iops: Option<i32>, pub publicly_accessible: Option<bool>, pub auto_minor_version_upgrade: Option<bool>, pub monitoring_interval: Option<i32>, pub monitoring_role_arn: Option<String>, pub database_insights_mode: Option<DatabaseInsightsMode>, pub performance_insights_enabled: Option<bool>, pub performance_insights_kms_key_id: Option<String>, pub performance_insights_retention_period: Option<i32>, pub serverless_v2_scaling_configuration: Option<ServerlessV2ScalingConfigurationInfo>, pub serverless_v2_platform_version: Option<String>, pub network_type: Option<String>, pub db_system_id: Option<String>, pub master_user_secret: Option<MasterUserSecret>, pub io_optimized_next_allowed_modification_time: Option<DateTime>, pub local_write_forwarding_status: Option<LocalWriteForwardingStatus>, pub aws_backup_recovery_point_arn: Option<String>, pub limitless_database: Option<LimitlessDatabase>, pub storage_throughput: Option<i32>, pub cluster_scalability_type: Option<ClusterScalabilityType>, pub certificate_details: Option<CertificateDetails>, pub engine_lifecycle_support: Option<String>,
}
Expand description

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§allocated_storage: Option<i32>

AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage can vary because Aurora DB cluster storage size adjusts as needed.

§availability_zones: Option<Vec<String>>

The list of Availability Zones (AZs) where instances in the DB cluster can be created.

§backup_retention_period: Option<i32>

The number of days for which automatic DB snapshots are retained.

§character_set_name: Option<String>

If present, specifies the name of the character set that this cluster is associated with.

§database_name: Option<String>

The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

§db_cluster_identifier: Option<String>

The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

§db_cluster_parameter_group: Option<String>

The name of the DB cluster parameter group for the DB cluster.

§db_subnet_group: Option<String>

Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

§status: Option<String>

The current state of this DB cluster.

§automatic_restart_time: Option<DateTime>

The time when a stopped DB cluster is restarted automatically.

§percent_progress: Option<String>

The progress of the operation as a percentage.

§earliest_restorable_time: Option<DateTime>

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

§endpoint: Option<String>

The connection endpoint for the primary instance of the DB cluster.

§reader_endpoint: Option<String>

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

If a failover occurs, and the Aurora 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 Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

§custom_endpoints: Option<Vec<String>>

The custom endpoints associated with the DB cluster.

§multi_az: Option<bool>

Indicates whether the DB cluster has instances in multiple Availability Zones.

§engine: Option<String>

The database engine used for this DB cluster.

§engine_version: Option<String>

The version of the database engine.

§latest_restorable_time: Option<DateTime>

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

§port: Option<i32>

The port that the database engine is listening on.

§master_username: Option<String>

The master username for the DB cluster.

§db_cluster_option_group_memberships: Option<Vec<DbClusterOptionGroupStatus>>

The list of option group memberships for this DB cluster.

§preferred_backup_window: Option<String>

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

§preferred_maintenance_window: Option<String>

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

§replication_source_identifier: Option<String>

The identifier of the source DB cluster if this DB cluster is a read replica.

§read_replica_identifiers: Option<Vec<String>>

Contains one or more identifiers of the read replicas associated with this DB cluster.

§status_infos: Option<Vec<DbClusterStatusInfo>>

Reserved for future use.

§db_cluster_members: Option<Vec<DbClusterMember>>

The list of DB instances that make up the DB cluster.

§vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>

The list of VPC security groups that the DB cluster belongs to.

§hosted_zone_id: Option<String>

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

§storage_encrypted: Option<bool>

Indicates whether the DB cluster is encrypted.

§kms_key_id: Option<String>

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

§db_cluster_resource_id: Option<String>

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

§db_cluster_arn: Option<String>

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

§associated_roles: Option<Vec<DbClusterRole>>

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

§iam_database_authentication_enabled: Option<bool>

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

§clone_group_id: Option<String>

The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.

If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.

For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster.

§cluster_create_time: Option<DateTime>

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

§earliest_backtrack_time: Option<DateTime>

The earliest time to which a DB cluster can be backtracked.

§backtrack_window: Option<i64>

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

§backtrack_consumed_change_records: Option<i64>

The number of change records stored for Backtrack.

§enabled_cloudwatch_logs_exports: Option<Vec<String>>

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

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

§capacity: Option<i32>

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

§engine_mode: Option<String>

The DB engine mode of the DB cluster, either provisioned or serverless.

For more information, see CreateDBCluster.

§scaling_configuration_info: Option<ScalingConfigurationInfo>

The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

§rds_custom_cluster_configuration: Option<RdsCustomClusterConfiguration>

Reserved for future use.

§deletion_protection: Option<bool>

Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

§http_endpoint_enabled: Option<bool>

Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.

When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

For more information, see Using RDS Data API in the Amazon Aurora User Guide.

§activity_stream_mode: Option<ActivityStreamMode>

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

§activity_stream_status: Option<ActivityStreamStatus>

The status of the database activity stream.

§activity_stream_kms_key_id: Option<String>

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

§activity_stream_kinesis_stream_name: Option<String>

The name of the Amazon Kinesis data stream used for the database activity stream.

§copy_tags_to_snapshot: Option<bool>

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

§cross_account_clone: Option<bool>

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

§domain_memberships: Option<Vec<DomainMembership>>

The Active Directory Domain membership records associated with the DB cluster.

§tag_list: 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.

§global_cluster_identifier: Option<String>

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

§global_write_forwarding_status: Option<WriteForwardingStatus>

The status of write forwarding for a secondary cluster in an Aurora global database.

§global_write_forwarding_requested: Option<bool>

Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

§pending_modified_values: Option<ClusterPendingModifiedValues>

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

§db_cluster_instance_class: Option<String>

The name of the compute and memory capacity class of the DB instance.

This setting is only for non-Aurora Multi-AZ DB clusters.

§storage_type: Option<String>

The storage type associated with the DB cluster.

§iops: Option<i32>

The Provisioned IOPS (I/O operations per second) value.

This setting is only for non-Aurora Multi-AZ DB clusters.

§publicly_accessible: Option<bool>

Indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

For more information, see CreateDBCluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

§auto_minor_version_upgrade: Option<bool>

Indicates whether minor version patches are applied automatically.

This setting is for Aurora DB clusters and Multi-AZ DB clusters.

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

§monitoring_interval: Option<i32>

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.

§monitoring_role_arn: Option<String>

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

§database_insights_mode: Option<DatabaseInsightsMode>

The mode of Database Insights that is enabled for the DB cluster.

§performance_insights_enabled: Option<bool>

Indicates whether Performance Insights is enabled for the DB cluster.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

§performance_insights_kms_key_id: Option<String>

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

§performance_insights_retention_period: Option<i32>

The number of days to retain Performance Insights data.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

Valid Values:

  • 7

  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

  • 731

Default: 7 days

§serverless_v2_scaling_configuration: Option<ServerlessV2ScalingConfigurationInfo>

The scaling configuration for an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

§serverless_v2_platform_version: Option<String>

The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the Amazon Aurora User Guide.

§network_type: Option<String>

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

This setting is only for Aurora DB clusters.

Valid Values: IPV4 | DUAL

§db_system_id: Option<String>

Reserved for future use.

§master_user_secret: Option<MasterUserSecret>

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

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

§io_optimized_next_allowed_modification_time: Option<DateTime>

The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

This setting is only for Aurora DB clusters.

§local_write_forwarding_status: Option<LocalWriteForwardingStatus>

Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.

§aws_backup_recovery_point_arn: Option<String>

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

§limitless_database: Option<LimitlessDatabase>

The details for Aurora Limitless Database.

§storage_throughput: Option<i32>

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

§cluster_scalability_type: Option<ClusterScalabilityType>

The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.

§certificate_details: Option<CertificateDetails>

The details of the DB instance’s server certificate.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

§engine_lifecycle_support: Option<String>

The lifecycle type for the DB cluster.

For more information, see CreateDBCluster.

Implementations§

Source§

impl DbCluster

Source

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

AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage can vary because Aurora DB cluster storage size adjusts as needed.

Source

pub fn availability_zones(&self) -> &[String]

The list of Availability Zones (AZs) where instances in the DB cluster can be created.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .availability_zones.is_none().

Source

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

The number of days for which automatic DB snapshots are retained.

Source

pub fn character_set_name(&self) -> Option<&str>

If present, specifies the name of the character set that this cluster is associated with.

Source

pub fn database_name(&self) -> Option<&str>

The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

Source

pub fn db_cluster_identifier(&self) -> Option<&str>

The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

Source

pub fn db_cluster_parameter_group(&self) -> Option<&str>

The name of the DB cluster parameter group for the DB cluster.

Source

pub fn db_subnet_group(&self) -> Option<&str>

Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

Source

pub fn status(&self) -> Option<&str>

The current state of this DB cluster.

Source

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

The time when a stopped DB cluster is restarted automatically.

Source

pub fn percent_progress(&self) -> Option<&str>

The progress of the operation as a percentage.

Source

pub fn 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) -> Option<&str>

The connection endpoint for the primary instance of the DB cluster.

Source

pub fn reader_endpoint(&self) -> Option<&str>

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

If a failover occurs, and the Aurora 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 Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Source

pub fn custom_endpoints(&self) -> &[String]

The custom endpoints associated with the DB cluster.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .custom_endpoints.is_none().

Source

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

Indicates whether the DB cluster has instances in multiple Availability Zones.

Source

pub fn engine(&self) -> Option<&str>

The database engine used for this DB cluster.

Source

pub fn engine_version(&self) -> Option<&str>

The version of the database engine.

Source

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

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

Source

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

The port that the database engine is listening on.

Source

pub fn master_username(&self) -> Option<&str>

The master username for the DB cluster.

Source

pub fn db_cluster_option_group_memberships( &self, ) -> &[DbClusterOptionGroupStatus]

The list of option group memberships for this DB cluster.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .db_cluster_option_group_memberships.is_none().

Source

pub fn preferred_backup_window(&self) -> Option<&str>

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) -> Option<&str>

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

Source

pub fn replication_source_identifier(&self) -> Option<&str>

The identifier of the source DB cluster if this DB cluster is a read replica.

Source

pub fn read_replica_identifiers(&self) -> &[String]

Contains one or more identifiers of the read replicas associated with this DB cluster.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .read_replica_identifiers.is_none().

Source

pub fn status_infos(&self) -> &[DbClusterStatusInfo]

Reserved for future use.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .status_infos.is_none().

Source

pub fn db_cluster_members(&self) -> &[DbClusterMember]

The list of DB instances that make up the DB cluster.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .db_cluster_members.is_none().

Source

pub fn vpc_security_groups(&self) -> &[VpcSecurityGroupMembership]

The list of VPC security groups that the DB cluster belongs to.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_security_groups.is_none().

Source

pub fn hosted_zone_id(&self) -> Option<&str>

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

Source

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

Indicates whether the DB cluster is encrypted.

Source

pub fn kms_key_id(&self) -> Option<&str>

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

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_cluster_resource_id(&self) -> Option<&str>

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

Source

pub fn db_cluster_arn(&self) -> Option<&str>

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

Source

pub fn associated_roles(&self) -> &[DbClusterRole]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .associated_roles.is_none().

Source

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

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

Source

pub fn clone_group_id(&self) -> Option<&str>

The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.

If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.

For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster.

Source

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

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

Source

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

The earliest time to which a DB cluster can be backtracked.

Source

pub fn backtrack_window(&self) -> Option<i64>

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

Source

pub fn backtrack_consumed_change_records(&self) -> Option<i64>

The number of change records stored for Backtrack.

Source

pub fn enabled_cloudwatch_logs_exports(&self) -> &[String]

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

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .enabled_cloudwatch_logs_exports.is_none().

Source

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

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

Source

pub fn engine_mode(&self) -> Option<&str>

The DB engine mode of the DB cluster, either provisioned or serverless.

For more information, see CreateDBCluster.

Source

pub fn scaling_configuration_info(&self) -> Option<&ScalingConfigurationInfo>

The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.

Source

pub fn rds_custom_cluster_configuration( &self, ) -> Option<&RdsCustomClusterConfiguration>

Reserved for future use.

Source

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

Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Source

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

Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.

When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

For more information, see Using RDS Data API in the Amazon Aurora User Guide.

Source

pub fn activity_stream_mode(&self) -> Option<&ActivityStreamMode>

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Source

pub fn activity_stream_status(&self) -> Option<&ActivityStreamStatus>

The status of the database activity stream.

Source

pub fn activity_stream_kms_key_id(&self) -> Option<&str>

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

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 activity_stream_kinesis_stream_name(&self) -> Option<&str>

The name of the Amazon Kinesis data stream used for the database activity stream.

Source

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

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

Source

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

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

Source

pub fn domain_memberships(&self) -> &[DomainMembership]

The Active Directory Domain membership records associated with the DB cluster.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .domain_memberships.is_none().

Source

pub fn tag_list(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_list.is_none().

Source

pub fn global_cluster_identifier(&self) -> Option<&str>

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

Source

pub fn global_write_forwarding_status(&self) -> Option<&WriteForwardingStatus>

The status of write forwarding for a secondary cluster in an Aurora global database.

Source

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

Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

Source

pub fn pending_modified_values(&self) -> Option<&ClusterPendingModifiedValues>

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

Source

pub fn db_cluster_instance_class(&self) -> Option<&str>

The name of the compute and memory capacity class of the DB instance.

This setting is only for non-Aurora Multi-AZ DB clusters.

Source

pub fn storage_type(&self) -> Option<&str>

The storage type associated with the DB cluster.

Source

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

The Provisioned IOPS (I/O operations per second) value.

This setting is only for non-Aurora Multi-AZ DB clusters.

Source

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

Indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

For more information, see CreateDBCluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

Source

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

Indicates whether minor version patches are applied automatically.

This setting is for Aurora DB clusters and Multi-AZ DB clusters.

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.

Source

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

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.

Source

pub fn monitoring_role_arn(&self) -> Option<&str>

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

Source

pub fn database_insights_mode(&self) -> Option<&DatabaseInsightsMode>

The mode of Database Insights that is enabled for the DB cluster.

Source

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

Indicates whether Performance Insights is enabled for the DB cluster.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

Source

pub fn performance_insights_kms_key_id(&self) -> Option<&str>

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

Source

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

The number of days to retain Performance Insights data.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

Valid Values:

  • 7

  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

  • 731

Default: 7 days

Source

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

The scaling configuration for an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

Source

pub fn serverless_v2_platform_version(&self) -> Option<&str>

The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the Amazon Aurora User Guide.

Source

pub fn network_type(&self) -> Option<&str>

The network type of the DB instance.

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

This setting is only for Aurora DB clusters.

Valid Values: IPV4 | DUAL

Source

pub fn db_system_id(&self) -> Option<&str>

Reserved for future use.

Source

pub fn master_user_secret(&self) -> Option<&MasterUserSecret>

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

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

Source

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

The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

This setting is only for Aurora DB clusters.

Source

pub fn local_write_forwarding_status( &self, ) -> Option<&LocalWriteForwardingStatus>

Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.

Source

pub fn aws_backup_recovery_point_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Source

pub fn limitless_database(&self) -> Option<&LimitlessDatabase>

The details for Aurora Limitless Database.

Source

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

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

Source

pub fn cluster_scalability_type(&self) -> Option<&ClusterScalabilityType>

The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.

Source

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

The details of the DB instance’s server certificate.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

Source

pub fn engine_lifecycle_support(&self) -> Option<&str>

The lifecycle type for the DB cluster.

For more information, see CreateDBCluster.

Source§

impl DbCluster

Source

pub fn builder() -> DbClusterBuilder

Creates a new builder-style object to manufacture DbCluster.

Trait Implementations§

Source§

impl Clone for DbCluster

Source§

fn clone(&self) -> DbCluster

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 DbCluster

Source§

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

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

impl PartialEq for DbCluster

Source§

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

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,