#[non_exhaustive]pub struct GetObjectOutput {Show 37 fields
pub body: ByteStream,
pub delete_marker: Option<bool>,
pub accept_ranges: Option<String>,
pub expiration: Option<String>,
pub restore: Option<String>,
pub last_modified: Option<DateTime>,
pub content_length: Option<i64>,
pub e_tag: Option<String>,
pub checksum_crc32: Option<String>,
pub checksum_crc32_c: Option<String>,
pub checksum_sha1: Option<String>,
pub checksum_sha256: Option<String>,
pub missing_meta: Option<i32>,
pub version_id: Option<String>,
pub cache_control: Option<String>,
pub content_disposition: Option<String>,
pub content_encoding: Option<String>,
pub content_language: Option<String>,
pub content_range: Option<String>,
pub content_type: Option<String>,
pub website_redirect_location: Option<String>,
pub server_side_encryption: Option<ServerSideEncryption>,
pub metadata: Option<HashMap<String, String>>,
pub sse_customer_algorithm: Option<String>,
pub sse_customer_key_md5: Option<String>,
pub ssekms_key_id: Option<String>,
pub bucket_key_enabled: Option<bool>,
pub storage_class: Option<StorageClass>,
pub request_charged: Option<RequestCharged>,
pub replication_status: Option<ReplicationStatus>,
pub parts_count: Option<i32>,
pub tag_count: Option<i32>,
pub object_lock_mode: Option<ObjectLockMode>,
pub object_lock_retain_until_date: Option<DateTime>,
pub object_lock_legal_hold_status: Option<ObjectLockLegalHoldStatus>,
pub expires: Option<DateTime>,
pub expires_string: Option<String>,
/* private fields */
}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.body: ByteStreamObject data.
delete_marker: Option<bool>Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
-
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes
x-amz-delete-marker: truein the response. -
If the specified version in the request is a delete marker, the response returns a
405 Method Not Allowederror and theLast-Modified: timestampresponse header.
accept_ranges: Option<String>Indicates that a range of bytes was specified in the request.
expiration: Option<String>If the object expiration is configured (see PutBucketLifecycleConfiguration ), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.
This functionality is not supported for directory buckets.
restore: Option<String>Provides information about object restoration action and expiration time of the restored object copy.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
last_modified: Option<DateTime>Date and time when the object was last modified.
General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
content_length: Option<i64>Size of the body in bytes.
e_tag: Option<String>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
checksum_crc32: Option<String>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksum_crc32_c: Option<String>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksum_sha1: Option<String>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksum_sha256: Option<String>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
missing_meta: Option<i32>This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
This functionality is not supported for directory buckets.
version_id: Option<String>Version ID of the object.
This functionality is not supported for directory buckets.
cache_control: Option<String>Specifies caching behavior along the request/reply chain.
content_disposition: Option<String>Specifies presentational information for the object.
content_encoding: Option<String>Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
content_language: Option<String>The language the content is in.
content_range: Option<String>The portion of the object returned in the response.
content_type: Option<String>A standard MIME type describing the format of the object data.
website_redirect_location: Option<String>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
This functionality is not supported for directory buckets.
server_side_encryption: Option<ServerSideEncryption>The server-side encryption algorithm used when you store this object in Amazon S3.
metadata: Option<HashMap<String, String>>A map of metadata to store with the object in S3.
sse_customer_algorithm: Option<String>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
sse_customer_key_md5: Option<String>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
ssekms_key_id: Option<String>If present, indicates the ID of the KMS key that was used for object encryption.
bucket_key_enabled: Option<bool>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
storage_class: Option<StorageClass>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
request_charged: Option<RequestCharged>If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
replication_status: Option<ReplicationStatus>Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
This functionality is not supported for directory buckets.
parts_count: Option<i32>The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.
tag_count: Option<i32>The number of tags, if any, on the object, when you have the relevant permission to read object tags.
You can use GetObjectTagging to retrieve the tag set associated with an object.
This functionality is not supported for directory buckets.
object_lock_mode: Option<ObjectLockMode>The Object Lock mode that's currently in place for this object.
This functionality is not supported for directory buckets.
object_lock_retain_until_date: Option<DateTime>The date and time when this object's Object Lock will expire.
This functionality is not supported for directory buckets.
object_lock_legal_hold_status: Option<ObjectLockLegalHoldStatus>Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.
This functionality is not supported for directory buckets.
expires: Option<DateTime>expires_string which contains the raw, unparsed value of this field.The date and time at which the object is no longer cacheable.
expires_string: Option<String>The date and time at which the object is no longer cacheable.
Implementations§
Source§impl GetObjectOutput
impl GetObjectOutput
Sourcepub fn body(&self) -> &ByteStream
pub fn body(&self) -> &ByteStream
Object data.
Sourcepub fn delete_marker(&self) -> Option<bool>
pub fn delete_marker(&self) -> Option<bool>
Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
-
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes
x-amz-delete-marker: truein the response. -
If the specified version in the request is a delete marker, the response returns a
405 Method Not Allowederror and theLast-Modified: timestampresponse header.
Sourcepub fn accept_ranges(&self) -> Option<&str>
pub fn accept_ranges(&self) -> Option<&str>
Indicates that a range of bytes was specified in the request.
Sourcepub fn expiration(&self) -> Option<&str>
pub fn expiration(&self) -> Option<&str>
If the object expiration is configured (see PutBucketLifecycleConfiguration ), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.
This functionality is not supported for directory buckets.
Sourcepub fn restore(&self) -> Option<&str>
pub fn restore(&self) -> Option<&str>
Provides information about object restoration action and expiration time of the restored object copy.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
Sourcepub fn last_modified(&self) -> Option<&DateTime>
pub fn last_modified(&self) -> Option<&DateTime>
Date and time when the object was last modified.
General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
Sourcepub fn content_length(&self) -> Option<i64>
pub fn content_length(&self) -> Option<i64>
Size of the body in bytes.
Sourcepub fn e_tag(&self) -> Option<&str>
pub fn e_tag(&self) -> Option<&str>
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
Sourcepub fn checksum_crc32(&self) -> Option<&str>
pub fn checksum_crc32(&self) -> Option<&str>
The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Sourcepub fn checksum_crc32_c(&self) -> Option<&str>
pub fn checksum_crc32_c(&self) -> Option<&str>
The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Sourcepub fn checksum_sha1(&self) -> Option<&str>
pub fn checksum_sha1(&self) -> Option<&str>
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Sourcepub fn checksum_sha256(&self) -> Option<&str>
pub fn checksum_sha256(&self) -> Option<&str>
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Sourcepub fn missing_meta(&self) -> Option<i32>
pub fn missing_meta(&self) -> Option<i32>
This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
This functionality is not supported for directory buckets.
Sourcepub fn version_id(&self) -> Option<&str>
pub fn version_id(&self) -> Option<&str>
Version ID of the object.
This functionality is not supported for directory buckets.
Sourcepub fn cache_control(&self) -> Option<&str>
pub fn cache_control(&self) -> Option<&str>
Specifies caching behavior along the request/reply chain.
Sourcepub fn content_disposition(&self) -> Option<&str>
pub fn content_disposition(&self) -> Option<&str>
Specifies presentational information for the object.
Sourcepub fn content_encoding(&self) -> Option<&str>
pub fn content_encoding(&self) -> Option<&str>
Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
Sourcepub fn content_language(&self) -> Option<&str>
pub fn content_language(&self) -> Option<&str>
The language the content is in.
Sourcepub fn content_range(&self) -> Option<&str>
pub fn content_range(&self) -> Option<&str>
The portion of the object returned in the response.
Sourcepub fn content_type(&self) -> Option<&str>
pub fn content_type(&self) -> Option<&str>
A standard MIME type describing the format of the object data.
Sourcepub fn website_redirect_location(&self) -> Option<&str>
pub fn website_redirect_location(&self) -> Option<&str>
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
This functionality is not supported for directory buckets.
Sourcepub fn server_side_encryption(&self) -> Option<&ServerSideEncryption>
pub fn server_side_encryption(&self) -> Option<&ServerSideEncryption>
The server-side encryption algorithm used when you store this object in Amazon S3.
Sourcepub fn metadata(&self) -> Option<&HashMap<String, String>>
pub fn metadata(&self) -> Option<&HashMap<String, String>>
A map of metadata to store with the object in S3.
Sourcepub fn sse_customer_algorithm(&self) -> Option<&str>
pub fn sse_customer_algorithm(&self) -> Option<&str>
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
Sourcepub fn sse_customer_key_md5(&self) -> Option<&str>
pub fn sse_customer_key_md5(&self) -> Option<&str>
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
Sourcepub fn ssekms_key_id(&self) -> Option<&str>
pub fn ssekms_key_id(&self) -> Option<&str>
If present, indicates the ID of the KMS key that was used for object encryption.
Sourcepub fn bucket_key_enabled(&self) -> Option<bool>
pub fn bucket_key_enabled(&self) -> Option<bool>
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
Sourcepub fn storage_class(&self) -> Option<&StorageClass>
pub fn storage_class(&self) -> Option<&StorageClass>
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
Sourcepub fn request_charged(&self) -> Option<&RequestCharged>
pub fn request_charged(&self) -> Option<&RequestCharged>
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
Sourcepub fn replication_status(&self) -> Option<&ReplicationStatus>
pub fn replication_status(&self) -> Option<&ReplicationStatus>
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
This functionality is not supported for directory buckets.
Sourcepub fn parts_count(&self) -> Option<i32>
pub fn parts_count(&self) -> Option<i32>
The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.
Sourcepub fn tag_count(&self) -> Option<i32>
pub fn tag_count(&self) -> Option<i32>
The number of tags, if any, on the object, when you have the relevant permission to read object tags.
You can use GetObjectTagging to retrieve the tag set associated with an object.
This functionality is not supported for directory buckets.
Sourcepub fn object_lock_mode(&self) -> Option<&ObjectLockMode>
pub fn object_lock_mode(&self) -> Option<&ObjectLockMode>
The Object Lock mode that's currently in place for this object.
This functionality is not supported for directory buckets.
Sourcepub fn object_lock_retain_until_date(&self) -> Option<&DateTime>
pub fn object_lock_retain_until_date(&self) -> Option<&DateTime>
The date and time when this object's Object Lock will expire.
This functionality is not supported for directory buckets.
Sourcepub fn object_lock_legal_hold_status(
&self,
) -> Option<&ObjectLockLegalHoldStatus>
pub fn object_lock_legal_hold_status( &self, ) -> Option<&ObjectLockLegalHoldStatus>
Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.
This functionality is not supported for directory buckets.
Sourcepub fn expires(&self) -> Option<&DateTime>
👎Deprecated: Please use expires_string which contains the raw, unparsed value of this field.
pub fn expires(&self) -> Option<&DateTime>
expires_string which contains the raw, unparsed value of this field.The date and time at which the object is no longer cacheable.
Sourcepub fn expires_string(&self) -> Option<&str>
pub fn expires_string(&self) -> Option<&str>
The date and time at which the object is no longer cacheable.
Source§impl GetObjectOutput
impl GetObjectOutput
Sourcepub fn builder() -> GetObjectOutputBuilder
pub fn builder() -> GetObjectOutputBuilder
Creates a new builder-style object to manufacture GetObjectOutput.
Trait Implementations§
Source§impl Debug for GetObjectOutput
impl Debug for GetObjectOutput
Source§impl RequestId for GetObjectOutput
impl RequestId for GetObjectOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.Source§impl RequestIdExt for GetObjectOutput
impl RequestIdExt for GetObjectOutput
Source§fn extended_request_id(&self) -> Option<&str>
fn extended_request_id(&self) -> Option<&str>
Auto Trait Implementations§
impl !Freeze for GetObjectOutput
impl !RefUnwindSafe for GetObjectOutput
impl Send for GetObjectOutput
impl Sync for GetObjectOutput
impl Unpin for GetObjectOutput
impl !UnwindSafe for GetObjectOutput
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> 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>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());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>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
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>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
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>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
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>
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>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());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>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
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>
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());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);