#[non_exhaustive]pub struct DbClusterSnapshotBuilder { /* private fields */ }
Expand description
A builder for DbClusterSnapshot
.
Implementations§
Source§impl DbClusterSnapshotBuilder
impl DbClusterSnapshotBuilder
Sourcepub fn availability_zones(self, input: impl Into<String>) -> Self
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
.
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
Sourcepub fn set_availability_zones(self, input: Option<Vec<String>>) -> Self
pub fn set_availability_zones(self, input: Option<Vec<String>>) -> Self
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
Sourcepub fn get_availability_zones(&self) -> &Option<Vec<String>>
pub fn get_availability_zones(&self) -> &Option<Vec<String>>
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
Sourcepub fn db_cluster_snapshot_identifier(self, input: impl Into<String>) -> Self
pub fn db_cluster_snapshot_identifier(self, input: impl Into<String>) -> Self
The identifier for the DB cluster snapshot.
Sourcepub fn set_db_cluster_snapshot_identifier(self, input: Option<String>) -> Self
pub fn set_db_cluster_snapshot_identifier(self, input: Option<String>) -> Self
The identifier for the DB cluster snapshot.
Sourcepub fn get_db_cluster_snapshot_identifier(&self) -> &Option<String>
pub fn get_db_cluster_snapshot_identifier(&self) -> &Option<String>
The identifier for the DB cluster snapshot.
Sourcepub fn db_cluster_identifier(self, input: impl Into<String>) -> Self
pub fn db_cluster_identifier(self, input: impl Into<String>) -> Self
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
Sourcepub fn set_db_cluster_identifier(self, input: Option<String>) -> Self
pub fn set_db_cluster_identifier(self, input: Option<String>) -> Self
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
Sourcepub fn get_db_cluster_identifier(&self) -> &Option<String>
pub fn get_db_cluster_identifier(&self) -> &Option<String>
The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
Sourcepub fn snapshot_create_time(self, input: DateTime) -> Self
pub fn snapshot_create_time(self, input: DateTime) -> Self
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
Sourcepub fn set_snapshot_create_time(self, input: Option<DateTime>) -> Self
pub fn set_snapshot_create_time(self, input: Option<DateTime>) -> Self
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
Sourcepub fn get_snapshot_create_time(&self) -> &Option<DateTime>
pub fn get_snapshot_create_time(&self) -> &Option<DateTime>
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
Sourcepub fn engine(self, input: impl Into<String>) -> Self
pub fn engine(self, input: impl Into<String>) -> Self
The name of the database engine for this DB cluster snapshot.
Sourcepub fn set_engine(self, input: Option<String>) -> Self
pub fn set_engine(self, input: Option<String>) -> Self
The name of the database engine for this DB cluster snapshot.
Sourcepub fn get_engine(&self) -> &Option<String>
pub fn get_engine(&self) -> &Option<String>
The name of the database engine for this DB cluster snapshot.
Sourcepub fn engine_mode(self, input: impl Into<String>) -> Self
pub fn engine_mode(self, input: impl Into<String>) -> Self
The engine mode of the database engine for this DB cluster snapshot.
Sourcepub fn set_engine_mode(self, input: Option<String>) -> Self
pub fn set_engine_mode(self, input: Option<String>) -> Self
The engine mode of the database engine for this DB cluster snapshot.
Sourcepub fn get_engine_mode(&self) -> &Option<String>
pub fn get_engine_mode(&self) -> &Option<String>
The engine mode of the database engine for this DB cluster snapshot.
Sourcepub fn allocated_storage(self, input: i32) -> Self
pub fn allocated_storage(self, input: i32) -> Self
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
Sourcepub fn set_allocated_storage(self, input: Option<i32>) -> Self
pub fn set_allocated_storage(self, input: Option<i32>) -> Self
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
Sourcepub fn get_allocated_storage(&self) -> &Option<i32>
pub fn get_allocated_storage(&self) -> &Option<i32>
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
Sourcepub fn status(self, input: impl Into<String>) -> Self
pub fn status(self, input: impl Into<String>) -> Self
The status of this DB cluster snapshot. Valid statuses are the following:
-
available
-
copying
-
creating
Sourcepub fn set_status(self, input: Option<String>) -> Self
pub fn set_status(self, input: Option<String>) -> Self
The status of this DB cluster snapshot. Valid statuses are the following:
-
available
-
copying
-
creating
Sourcepub fn get_status(&self) -> &Option<String>
pub fn get_status(&self) -> &Option<String>
The status of this DB cluster snapshot. Valid statuses are the following:
-
available
-
copying
-
creating
Sourcepub fn port(self, input: i32) -> Self
pub fn port(self, input: i32) -> Self
The port that the DB cluster was listening on at the time of the snapshot.
Sourcepub fn set_port(self, input: Option<i32>) -> Self
pub fn set_port(self, input: Option<i32>) -> Self
The port that the DB cluster was listening on at the time of the snapshot.
Sourcepub fn get_port(&self) -> &Option<i32>
pub fn get_port(&self) -> &Option<i32>
The port that the DB cluster was listening on at the time of the snapshot.
Sourcepub fn vpc_id(self, input: impl Into<String>) -> Self
pub fn vpc_id(self, input: impl Into<String>) -> Self
The VPC ID associated with the DB cluster snapshot.
Sourcepub fn set_vpc_id(self, input: Option<String>) -> Self
pub fn set_vpc_id(self, input: Option<String>) -> Self
The VPC ID associated with the DB cluster snapshot.
Sourcepub fn get_vpc_id(&self) -> &Option<String>
pub fn get_vpc_id(&self) -> &Option<String>
The VPC ID associated with the DB cluster snapshot.
Sourcepub fn cluster_create_time(self, input: DateTime) -> Self
pub fn cluster_create_time(self, input: DateTime) -> Self
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
Sourcepub fn set_cluster_create_time(self, input: Option<DateTime>) -> Self
pub fn set_cluster_create_time(self, input: Option<DateTime>) -> Self
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
Sourcepub fn get_cluster_create_time(&self) -> &Option<DateTime>
pub fn get_cluster_create_time(&self) -> &Option<DateTime>
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
Sourcepub fn master_username(self, input: impl Into<String>) -> Self
pub fn master_username(self, input: impl Into<String>) -> Self
The master username for this DB cluster snapshot.
Sourcepub fn set_master_username(self, input: Option<String>) -> Self
pub fn set_master_username(self, input: Option<String>) -> Self
The master username for this DB cluster snapshot.
Sourcepub fn get_master_username(&self) -> &Option<String>
pub fn get_master_username(&self) -> &Option<String>
The master username for this DB cluster snapshot.
Sourcepub fn engine_version(self, input: impl Into<String>) -> Self
pub fn engine_version(self, input: impl Into<String>) -> Self
The version of the database engine for this DB cluster snapshot.
Sourcepub fn set_engine_version(self, input: Option<String>) -> Self
pub fn set_engine_version(self, input: Option<String>) -> Self
The version of the database engine for this DB cluster snapshot.
Sourcepub fn get_engine_version(&self) -> &Option<String>
pub fn get_engine_version(&self) -> &Option<String>
The version of the database engine for this DB cluster snapshot.
Sourcepub fn license_model(self, input: impl Into<String>) -> Self
pub fn license_model(self, input: impl Into<String>) -> Self
The license model information for this DB cluster snapshot.
Sourcepub fn set_license_model(self, input: Option<String>) -> Self
pub fn set_license_model(self, input: Option<String>) -> Self
The license model information for this DB cluster snapshot.
Sourcepub fn get_license_model(&self) -> &Option<String>
pub fn get_license_model(&self) -> &Option<String>
The license model information for this DB cluster snapshot.
Sourcepub fn snapshot_type(self, input: impl Into<String>) -> Self
pub fn snapshot_type(self, input: impl Into<String>) -> Self
The type of the DB cluster snapshot.
Sourcepub fn set_snapshot_type(self, input: Option<String>) -> Self
pub fn set_snapshot_type(self, input: Option<String>) -> Self
The type of the DB cluster snapshot.
Sourcepub fn get_snapshot_type(&self) -> &Option<String>
pub fn get_snapshot_type(&self) -> &Option<String>
The type of the DB cluster snapshot.
Sourcepub fn percent_progress(self, input: i32) -> Self
pub fn percent_progress(self, input: i32) -> Self
The percentage of the estimated data that has been transferred.
Sourcepub fn set_percent_progress(self, input: Option<i32>) -> Self
pub fn set_percent_progress(self, input: Option<i32>) -> Self
The percentage of the estimated data that has been transferred.
Sourcepub fn get_percent_progress(&self) -> &Option<i32>
pub fn get_percent_progress(&self) -> &Option<i32>
The percentage of the estimated data that has been transferred.
Sourcepub fn storage_encrypted(self, input: bool) -> Self
pub fn storage_encrypted(self, input: bool) -> Self
Indicates whether the DB cluster snapshot is encrypted.
Sourcepub fn set_storage_encrypted(self, input: Option<bool>) -> Self
pub fn set_storage_encrypted(self, input: Option<bool>) -> Self
Indicates whether the DB cluster snapshot is encrypted.
Sourcepub fn get_storage_encrypted(&self) -> &Option<bool>
pub fn get_storage_encrypted(&self) -> &Option<bool>
Indicates whether the DB cluster snapshot is encrypted.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
If StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
If StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
If StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Sourcepub fn db_cluster_snapshot_arn(self, input: impl Into<String>) -> Self
pub fn db_cluster_snapshot_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the DB cluster snapshot.
Sourcepub fn set_db_cluster_snapshot_arn(self, input: Option<String>) -> Self
pub fn set_db_cluster_snapshot_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the DB cluster snapshot.
Sourcepub fn get_db_cluster_snapshot_arn(&self) -> &Option<String>
pub fn get_db_cluster_snapshot_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the DB cluster snapshot.
Sourcepub fn source_db_cluster_snapshot_arn(self, input: impl Into<String>) -> Self
pub fn source_db_cluster_snapshot_arn(self, input: impl Into<String>) -> Self
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
Sourcepub fn set_source_db_cluster_snapshot_arn(self, input: Option<String>) -> Self
pub fn set_source_db_cluster_snapshot_arn(self, input: Option<String>) -> Self
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
Sourcepub fn get_source_db_cluster_snapshot_arn(&self) -> &Option<String>
pub fn get_source_db_cluster_snapshot_arn(&self) -> &Option<String>
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
Sourcepub fn iam_database_authentication_enabled(self, input: bool) -> Self
pub fn iam_database_authentication_enabled(self, input: bool) -> Self
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
Sourcepub fn set_iam_database_authentication_enabled(
self,
input: Option<bool>,
) -> Self
pub fn set_iam_database_authentication_enabled( self, input: Option<bool>, ) -> Self
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
Sourcepub fn get_iam_database_authentication_enabled(&self) -> &Option<bool>
pub fn get_iam_database_authentication_enabled(&self) -> &Option<bool>
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
Sourcepub fn tag_list(self, input: Tag) -> Self
pub fn tag_list(self, input: Tag) -> Self
Appends an item to tag_list
.
To override the contents of this collection use set_tag_list
.
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Sourcepub fn set_tag_list(self, input: Option<Vec<Tag>>) -> Self
pub fn set_tag_list(self, input: Option<Vec<Tag>>) -> Self
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Sourcepub fn get_tag_list(&self) -> &Option<Vec<Tag>>
pub fn get_tag_list(&self) -> &Option<Vec<Tag>>
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
Sourcepub fn db_system_id(self, input: impl Into<String>) -> Self
pub fn db_system_id(self, input: impl Into<String>) -> Self
Reserved for future use.
Sourcepub fn set_db_system_id(self, input: Option<String>) -> Self
pub fn set_db_system_id(self, input: Option<String>) -> Self
Reserved for future use.
Sourcepub fn get_db_system_id(&self) -> &Option<String>
pub fn get_db_system_id(&self) -> &Option<String>
Reserved for future use.
Sourcepub fn storage_type(self, input: impl Into<String>) -> Self
pub fn storage_type(self, input: impl Into<String>) -> Self
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
Sourcepub fn set_storage_type(self, input: Option<String>) -> Self
pub fn set_storage_type(self, input: Option<String>) -> Self
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
Sourcepub fn get_storage_type(&self) -> &Option<String>
pub fn get_storage_type(&self) -> &Option<String>
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
Sourcepub fn db_cluster_resource_id(self, input: impl Into<String>) -> Self
pub fn db_cluster_resource_id(self, input: impl Into<String>) -> Self
The resource ID of the DB cluster that this DB cluster snapshot was created from.
Sourcepub fn set_db_cluster_resource_id(self, input: Option<String>) -> Self
pub fn set_db_cluster_resource_id(self, input: Option<String>) -> Self
The resource ID of the DB cluster that this DB cluster snapshot was created from.
Sourcepub fn get_db_cluster_resource_id(&self) -> &Option<String>
pub fn get_db_cluster_resource_id(&self) -> &Option<String>
The resource ID of the DB cluster that this DB cluster snapshot was created from.
Sourcepub fn storage_throughput(self, input: i32) -> Self
pub fn storage_throughput(self, input: i32) -> Self
The storage throughput for the DB cluster snapshot. 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.
Sourcepub fn set_storage_throughput(self, input: Option<i32>) -> Self
pub fn set_storage_throughput(self, input: Option<i32>) -> Self
The storage throughput for the DB cluster snapshot. 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.
Sourcepub fn get_storage_throughput(&self) -> &Option<i32>
pub fn get_storage_throughput(&self) -> &Option<i32>
The storage throughput for the DB cluster snapshot. 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.
Sourcepub fn build(self) -> DbClusterSnapshot
pub fn build(self) -> DbClusterSnapshot
Consumes the builder and constructs a DbClusterSnapshot
.
Trait Implementations§
Source§impl Clone for DbClusterSnapshotBuilder
impl Clone for DbClusterSnapshotBuilder
Source§fn clone(&self) -> DbClusterSnapshotBuilder
fn clone(&self) -> DbClusterSnapshotBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DbClusterSnapshotBuilder
impl Debug for DbClusterSnapshotBuilder
Source§impl Default for DbClusterSnapshotBuilder
impl Default for DbClusterSnapshotBuilder
Source§fn default() -> DbClusterSnapshotBuilder
fn default() -> DbClusterSnapshotBuilder
Source§impl PartialEq for DbClusterSnapshotBuilder
impl PartialEq for DbClusterSnapshotBuilder
impl StructuralPartialEq for DbClusterSnapshotBuilder
Auto Trait Implementations§
impl Freeze for DbClusterSnapshotBuilder
impl RefUnwindSafe for DbClusterSnapshotBuilder
impl Send for DbClusterSnapshotBuilder
impl Sync for DbClusterSnapshotBuilder
impl Unpin for DbClusterSnapshotBuilder
impl UnwindSafe for DbClusterSnapshotBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);