#[non_exhaustive]pub struct BucketMetadata {Show 27 fields
pub account_id: Option<String>,
pub allows_unencrypted_object_uploads: Option<AllowsUnencryptedObjectUploads>,
pub automated_discovery_monitoring_status: Option<AutomatedDiscoveryMonitoringStatus>,
pub bucket_arn: Option<String>,
pub bucket_created_at: Option<DateTime>,
pub bucket_name: Option<String>,
pub classifiable_object_count: Option<i64>,
pub classifiable_size_in_bytes: Option<i64>,
pub error_code: Option<BucketMetadataErrorCode>,
pub error_message: Option<String>,
pub job_details: Option<JobDetails>,
pub last_automated_discovery_time: Option<DateTime>,
pub last_updated: Option<DateTime>,
pub object_count: Option<i64>,
pub object_count_by_encryption_type: Option<ObjectCountByEncryptionType>,
pub public_access: Option<BucketPublicAccess>,
pub region: Option<String>,
pub replication_details: Option<ReplicationDetails>,
pub sensitivity_score: Option<i32>,
pub server_side_encryption: Option<BucketServerSideEncryption>,
pub shared_access: Option<SharedAccess>,
pub size_in_bytes: Option<i64>,
pub size_in_bytes_compressed: Option<i64>,
pub tags: Option<Vec<KeyValuePair>>,
pub unclassifiable_object_count: Option<ObjectLevelStatistics>,
pub unclassifiable_object_size_in_bytes: Option<ObjectLevelStatistics>,
pub versioning: Option<bool>,
}
Expand description
Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see How Macie monitors Amazon S3 data security in the Amazon Macie User Guide.
If an error or issue prevents Macie from retrieving and processing metadata from Amazon S3 for the bucket or the bucket's objects, the value for the versioning property is false and the value for most other properties is null or UNKNOWN. Key exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause, refer to the errorCode and errorMessage values.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.account_id: Option<String>
The unique identifier for the Amazon Web Services account that owns the bucket.
allows_unencrypted_object_uploads: Option<AllowsUnencryptedObjectUploads>
Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:
-
FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.
-
TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.
-
UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.
Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.
automated_discovery_monitoring_status: Option<AutomatedDiscoveryMonitoringStatus>
Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.
bucket_arn: Option<String>
The Amazon Resource Name (ARN) of the bucket.
bucket_created_at: Option<DateTime>
The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket.
bucket_name: Option<String>
The name of the bucket.
classifiable_object_count: Option<i64>
The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
classifiable_size_in_bytes: Option<i64>
The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
error_code: Option<BucketMetadataErrorCode>
The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. Possible values are:
-
ACCESS_DENIED - Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request.
-
BUCKET_COUNT_EXCEEDS_QUOTA - Retrieving and processing the information would exceed the quota for the number of buckets that Macie monitors for an account (10,000).
If this value is null, Macie was able to retrieve and process the information.
error_message: Option<String>
A brief description of the error or issue (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.
job_details: Option<JobDetails>
Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.
last_automated_discovery_time: Option<DateTime>
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed objects in the bucket while performing automated sensitive data discovery. This value is null if this analysis hasn't occurred.
last_updated: Option<DateTime>
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the bucket.
object_count: Option<i64>
The total number of objects in the bucket.
object_count_by_encryption_type: Option<ObjectCountByEncryptionType>
The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.
public_access: Option<BucketPublicAccess>
Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.
region: Option<String>
The Amazon Web Services Region that hosts the bucket.
replication_details: Option<ReplicationDetails>
Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.
sensitivity_score: Option<i32>
The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive).
If automated sensitive data discovery has never been enabled for your account or it's been disabled for your organization or standalone account for more than 30 days, possible values are: 1, the bucket is empty; or, 50, the bucket stores objects but it's been excluded from recent analyses.
server_side_encryption: Option<BucketServerSideEncryption>
The default server-side encryption settings for the bucket.
Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:
-
EXTERNAL - The bucket is shared with one or more of the following or any combination of the following: a CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn't part of your Amazon Macie organization.
-
INTERNAL - The bucket is shared with one or more Amazon Web Services accounts that are part of your Amazon Macie organization. It isn't shared with a CloudFront OAI or OAC.
-
NOT_SHARED - The bucket isn't shared with another Amazon Web Services account, a CloudFront OAI, or a CloudFront OAC.
-
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.
size_in_bytes: Option<i64>
The total storage size, in bytes, of the bucket.
If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.
size_in_bytes_compressed: Option<i64>
The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
An array that specifies the tags (keys and values) that are associated with the bucket.
unclassifiable_object_count: Option<ObjectLevelStatistics>
The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
unclassifiable_object_size_in_bytes: Option<ObjectLevelStatistics>
The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
versioning: Option<bool>
Specifies whether versioning is enabled for the bucket.
Implementations§
Source§impl BucketMetadata
impl BucketMetadata
Sourcepub fn account_id(&self) -> Option<&str>
pub fn account_id(&self) -> Option<&str>
The unique identifier for the Amazon Web Services account that owns the bucket.
Sourcepub fn allows_unencrypted_object_uploads(
&self,
) -> Option<&AllowsUnencryptedObjectUploads>
pub fn allows_unencrypted_object_uploads( &self, ) -> Option<&AllowsUnencryptedObjectUploads>
Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are added to the bucket. Possible values are:
-
FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include a valid server-side encryption header.
-
TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include a valid server-side encryption header.
-
UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.
Valid server-side encryption headers are: x-amz-server-side-encryption with a value of AES256 or aws:kms, and x-amz-server-side-encryption-customer-algorithm with a value of AES256.
Sourcepub fn automated_discovery_monitoring_status(
&self,
) -> Option<&AutomatedDiscoveryMonitoringStatus>
pub fn automated_discovery_monitoring_status( &self, ) -> Option<&AutomatedDiscoveryMonitoringStatus>
Specifies whether automated sensitive data discovery is currently configured to analyze objects in the bucket. Possible values are: MONITORED, the bucket is included in analyses; and, NOT_MONITORED, the bucket is excluded from analyses. If automated sensitive data discovery is disabled for your account, this value is NOT_MONITORED.
Sourcepub fn bucket_arn(&self) -> Option<&str>
pub fn bucket_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the bucket.
Sourcepub fn bucket_created_at(&self) -> Option<&DateTime>
pub fn bucket_created_at(&self) -> Option<&DateTime>
The date and time, in UTC and extended ISO 8601 format, when the bucket was created. This value can also indicate when changes such as edits to the bucket's policy were most recently made to the bucket.
Sourcepub fn bucket_name(&self) -> Option<&str>
pub fn bucket_name(&self) -> Option<&str>
The name of the bucket.
Sourcepub fn classifiable_object_count(&self) -> Option<i64>
pub fn classifiable_object_count(&self) -> Option<i64>
The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
Sourcepub fn classifiable_size_in_bytes(&self) -> Option<i64>
pub fn classifiable_size_in_bytes(&self) -> Option<i64>
The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
Sourcepub fn error_code(&self) -> Option<&BucketMetadataErrorCode>
pub fn error_code(&self) -> Option<&BucketMetadataErrorCode>
The code for an error or issue that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. Possible values are:
-
ACCESS_DENIED - Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request.
-
BUCKET_COUNT_EXCEEDS_QUOTA - Retrieving and processing the information would exceed the quota for the number of buckets that Macie monitors for an account (10,000).
If this value is null, Macie was able to retrieve and process the information.
Sourcepub fn error_message(&self) -> Option<&str>
pub fn error_message(&self) -> Option<&str>
A brief description of the error or issue (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.
Sourcepub fn job_details(&self) -> Option<&JobDetails>
pub fn job_details(&self) -> Option<&JobDetails>
Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.
Sourcepub fn last_automated_discovery_time(&self) -> Option<&DateTime>
pub fn last_automated_discovery_time(&self) -> Option<&DateTime>
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently analyzed objects in the bucket while performing automated sensitive data discovery. This value is null if this analysis hasn't occurred.
Sourcepub fn last_updated(&self) -> Option<&DateTime>
pub fn last_updated(&self) -> Option<&DateTime>
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved bucket or object metadata from Amazon S3 for the bucket.
Sourcepub fn object_count(&self) -> Option<i64>
pub fn object_count(&self) -> Option<i64>
The total number of objects in the bucket.
Sourcepub fn object_count_by_encryption_type(
&self,
) -> Option<&ObjectCountByEncryptionType>
pub fn object_count_by_encryption_type( &self, ) -> Option<&ObjectCountByEncryptionType>
The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.
Sourcepub fn public_access(&self) -> Option<&BucketPublicAccess>
pub fn public_access(&self) -> Option<&BucketPublicAccess>
Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.
Sourcepub fn replication_details(&self) -> Option<&ReplicationDetails>
pub fn replication_details(&self) -> Option<&ReplicationDetails>
Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.
Sourcepub fn sensitivity_score(&self) -> Option<i32>
pub fn sensitivity_score(&self) -> Option<i32>
The sensitivity score for the bucket, ranging from -1 (classification error) to 100 (sensitive).
If automated sensitive data discovery has never been enabled for your account or it's been disabled for your organization or standalone account for more than 30 days, possible values are: 1, the bucket is empty; or, 50, the bucket stores objects but it's been excluded from recent analyses.
Sourcepub fn server_side_encryption(&self) -> Option<&BucketServerSideEncryption>
pub fn server_side_encryption(&self) -> Option<&BucketServerSideEncryption>
The default server-side encryption settings for the bucket.
Specifies whether the bucket is shared with another Amazon Web Services account, an Amazon CloudFront origin access identity (OAI), or a CloudFront origin access control (OAC). Possible values are:
-
EXTERNAL - The bucket is shared with one or more of the following or any combination of the following: a CloudFront OAI, a CloudFront OAC, or an Amazon Web Services account that isn't part of your Amazon Macie organization.
-
INTERNAL - The bucket is shared with one or more Amazon Web Services accounts that are part of your Amazon Macie organization. It isn't shared with a CloudFront OAI or OAC.
-
NOT_SHARED - The bucket isn't shared with another Amazon Web Services account, a CloudFront OAI, or a CloudFront OAC.
-
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
An Amazon Macie organization is a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.
Sourcepub fn size_in_bytes(&self) -> Option<i64>
pub fn size_in_bytes(&self) -> Option<i64>
The total storage size, in bytes, of the bucket.
If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.
Sourcepub fn size_in_bytes_compressed(&self) -> Option<i64>
pub fn size_in_bytes_compressed(&self) -> Option<i64>
The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.
An array that specifies the tags (keys and values) that are associated with the bucket.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn unclassifiable_object_count(&self) -> Option<&ObjectLevelStatistics>
pub fn unclassifiable_object_count(&self) -> Option<&ObjectLevelStatistics>
The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
Sourcepub fn unclassifiable_object_size_in_bytes(
&self,
) -> Option<&ObjectLevelStatistics>
pub fn unclassifiable_object_size_in_bytes( &self, ) -> Option<&ObjectLevelStatistics>
The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
Sourcepub fn versioning(&self) -> Option<bool>
pub fn versioning(&self) -> Option<bool>
Specifies whether versioning is enabled for the bucket.
Source§impl BucketMetadata
impl BucketMetadata
Sourcepub fn builder() -> BucketMetadataBuilder
pub fn builder() -> BucketMetadataBuilder
Creates a new builder-style object to manufacture BucketMetadata
.
Trait Implementations§
Source§impl Clone for BucketMetadata
impl Clone for BucketMetadata
Source§fn clone(&self) -> BucketMetadata
fn clone(&self) -> BucketMetadata
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for BucketMetadata
impl Debug for BucketMetadata
Source§impl PartialEq for BucketMetadata
impl PartialEq for BucketMetadata
impl StructuralPartialEq for BucketMetadata
Auto Trait Implementations§
impl Freeze for BucketMetadata
impl RefUnwindSafe for BucketMetadata
impl Send for BucketMetadata
impl Sync for BucketMetadata
impl Unpin for BucketMetadata
impl UnwindSafe for BucketMetadata
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);