#[non_exhaustive]pub enum UpdateTrailError {
Show 34 variants
CloudTrailAccessNotEnabledException(CloudTrailAccessNotEnabledException),
CloudTrailArnInvalidException(CloudTrailArnInvalidException),
CloudTrailInvalidClientTokenIdException(CloudTrailInvalidClientTokenIdException),
CloudWatchLogsDeliveryUnavailableException(CloudWatchLogsDeliveryUnavailableException),
ConflictException(ConflictException),
InsufficientDependencyServiceAccessPermissionException(InsufficientDependencyServiceAccessPermissionException),
InsufficientEncryptionPolicyException(InsufficientEncryptionPolicyException),
InsufficientS3BucketPolicyException(InsufficientS3BucketPolicyException),
InsufficientSnsTopicPolicyException(InsufficientSnsTopicPolicyException),
InvalidCloudWatchLogsLogGroupArnException(InvalidCloudWatchLogsLogGroupArnException),
InvalidCloudWatchLogsRoleArnException(InvalidCloudWatchLogsRoleArnException),
InvalidEventSelectorsException(InvalidEventSelectorsException),
InvalidHomeRegionException(InvalidHomeRegionException),
InvalidKmsKeyIdException(InvalidKmsKeyIdException),
InvalidParameterCombinationException(InvalidParameterCombinationException),
InvalidParameterException(InvalidParameterException),
InvalidS3BucketNameException(InvalidS3BucketNameException),
InvalidS3PrefixException(InvalidS3PrefixException),
InvalidSnsTopicNameException(InvalidSnsTopicNameException),
InvalidTrailNameException(InvalidTrailNameException),
KmsException(KmsException),
KmsKeyDisabledException(KmsKeyDisabledException),
KmsKeyNotFoundException(KmsKeyNotFoundException),
NoManagementAccountSlrExistsException(NoManagementAccountSlrExistsException),
NotOrganizationMasterAccountException(NotOrganizationMasterAccountException),
OperationNotPermittedException(OperationNotPermittedException),
OrganizationNotInAllFeaturesModeException(OrganizationNotInAllFeaturesModeException),
OrganizationsNotInUseException(OrganizationsNotInUseException),
S3BucketDoesNotExistException(S3BucketDoesNotExistException),
ThrottlingException(ThrottlingException),
TrailNotFoundException(TrailNotFoundException),
TrailNotProvidedException(TrailNotProvidedException),
UnsupportedOperationException(UnsupportedOperationException),
Unhandled(Unhandled),
}
Expand description
Error type for the UpdateTrailError
operation.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
CloudTrailAccessNotEnabledException(CloudTrailAccessNotEnabledException)
This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.
CloudTrailArnInvalidException(CloudTrailArnInvalidException)
This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash
The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
CloudTrailInvalidClientTokenIdException(CloudTrailInvalidClientTokenIdException)
This exception is thrown when a call results in the InvalidClientTokenId
error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account.
Cannot set a CloudWatch Logs delivery for this Region.
ConflictException(ConflictException)
This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
InsufficientDependencyServiceAccessPermissionException(InsufficientDependencyServiceAccessPermissionException)
This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
InsufficientEncryptionPolicyException(InsufficientEncryptionPolicyException)
For the CreateTrail
PutInsightSelectors
, UpdateTrail
, StartQuery
, and StartImport
operations, this exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
For all other operations, this exception is thrown when the policy for the KMS key does not have sufficient permissions for the operation.
InsufficientS3BucketPolicyException(InsufficientS3BucketPolicyException)
This exception is thrown when the policy on the S3 bucket is not sufficient.
InsufficientSnsTopicPolicyException(InsufficientSnsTopicPolicyException)
This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
InvalidCloudWatchLogsLogGroupArnException(InvalidCloudWatchLogsLogGroupArnException)
This exception is thrown when the provided CloudWatch Logs log group is not valid.
InvalidCloudWatchLogsRoleArnException(InvalidCloudWatchLogsRoleArnException)
This exception is thrown when the provided role is not valid.
InvalidEventSelectorsException(InvalidEventSelectorsException)
This exception is thrown when the PutEventSelectors
operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.
You can:
-
Specify a valid number of event selectors (1 to 5) for a trail.
-
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
-
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
-
Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
InvalidHomeRegionException(InvalidHomeRegionException)
This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
InvalidKmsKeyIdException(InvalidKmsKeyIdException)
This exception is thrown when the KMS key ARN is not valid.
InvalidParameterCombinationException(InvalidParameterCombinationException)
This exception is thrown when the combination of parameters provided is not valid.
InvalidParameterException(InvalidParameterException)
The request includes a parameter that is not valid.
InvalidS3BucketNameException(InvalidS3BucketNameException)
This exception is thrown when the provided S3 bucket name is not valid.
InvalidS3PrefixException(InvalidS3PrefixException)
This exception is thrown when the provided S3 prefix is not valid.
InvalidSnsTopicNameException(InvalidSnsTopicNameException)
This exception is thrown when the provided SNS topic name is not valid.
InvalidTrailNameException(InvalidTrailNameException)
This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
KmsException(KmsException)
This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
KmsKeyDisabledException(KmsKeyDisabledException)
This exception is no longer in use.
KmsKeyNotFoundException(KmsKeyNotFoundException)
This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
NoManagementAccountSlrExistsException(NoManagementAccountSlrExistsException)
This exception is thrown when the management account does not have a service-linked role.
NotOrganizationMasterAccountException(NotOrganizationMasterAccountException)
This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.
OperationNotPermittedException(OperationNotPermittedException)
This exception is thrown when the requested operation is not permitted.
OrganizationNotInAllFeaturesModeException(OrganizationNotInAllFeaturesModeException)
This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
OrganizationsNotInUseException(OrganizationsNotInUseException)
This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
S3BucketDoesNotExistException(S3BucketDoesNotExistException)
This exception is thrown when the specified S3 bucket does not exist.
ThrottlingException(ThrottlingException)
This exception is thrown when the request rate exceeds the limit.
TrailNotFoundException(TrailNotFoundException)
This exception is thrown when the trail with the given name is not found.
TrailNotProvidedException(TrailNotProvidedException)
This exception is no longer in use.
UnsupportedOperationException(UnsupportedOperationException)
This exception is thrown when the requested operation is not supported.
Unhandled(Unhandled)
Unhandled
directly is not forwards compatible. Instead, match using a variable wildcard pattern and check .code()
:
err if err.code() == Some("SpecificExceptionCode") => { /* handle the error */ }
See ProvideErrorMetadata
for what information is available for the error.An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
Implementations§
Source§impl UpdateTrailError
impl UpdateTrailError
Sourcepub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self
pub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self
Creates the UpdateTrailError::Unhandled
variant from any error type.
Sourcepub fn generic(err: ErrorMetadata) -> Self
pub fn generic(err: ErrorMetadata) -> Self
Creates the UpdateTrailError::Unhandled
variant from an ErrorMetadata
.
Sourcepub fn meta(&self) -> &ErrorMetadata
pub fn meta(&self) -> &ErrorMetadata
Returns error metadata, which includes the error code, message, request ID, and potentially additional information.
Sourcepub fn is_cloud_trail_access_not_enabled_exception(&self) -> bool
pub fn is_cloud_trail_access_not_enabled_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::CloudTrailAccessNotEnabledException
.
Sourcepub fn is_cloud_trail_arn_invalid_exception(&self) -> bool
pub fn is_cloud_trail_arn_invalid_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::CloudTrailArnInvalidException
.
Sourcepub fn is_cloud_trail_invalid_client_token_id_exception(&self) -> bool
pub fn is_cloud_trail_invalid_client_token_id_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::CloudTrailInvalidClientTokenIdException
.
Returns true
if the error kind is UpdateTrailError::CloudWatchLogsDeliveryUnavailableException
.
Sourcepub fn is_conflict_exception(&self) -> bool
pub fn is_conflict_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::ConflictException
.
Sourcepub fn is_insufficient_dependency_service_access_permission_exception(
&self,
) -> bool
pub fn is_insufficient_dependency_service_access_permission_exception( &self, ) -> bool
Returns true
if the error kind is UpdateTrailError::InsufficientDependencyServiceAccessPermissionException
.
Sourcepub fn is_insufficient_encryption_policy_exception(&self) -> bool
pub fn is_insufficient_encryption_policy_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InsufficientEncryptionPolicyException
.
Sourcepub fn is_insufficient_s3_bucket_policy_exception(&self) -> bool
pub fn is_insufficient_s3_bucket_policy_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InsufficientS3BucketPolicyException
.
Sourcepub fn is_insufficient_sns_topic_policy_exception(&self) -> bool
pub fn is_insufficient_sns_topic_policy_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InsufficientSnsTopicPolicyException
.
Sourcepub fn is_invalid_cloud_watch_logs_log_group_arn_exception(&self) -> bool
pub fn is_invalid_cloud_watch_logs_log_group_arn_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidCloudWatchLogsLogGroupArnException
.
Sourcepub fn is_invalid_cloud_watch_logs_role_arn_exception(&self) -> bool
pub fn is_invalid_cloud_watch_logs_role_arn_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidCloudWatchLogsRoleArnException
.
Sourcepub fn is_invalid_event_selectors_exception(&self) -> bool
pub fn is_invalid_event_selectors_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidEventSelectorsException
.
Sourcepub fn is_invalid_home_region_exception(&self) -> bool
pub fn is_invalid_home_region_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidHomeRegionException
.
Sourcepub fn is_invalid_kms_key_id_exception(&self) -> bool
pub fn is_invalid_kms_key_id_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidKmsKeyIdException
.
Sourcepub fn is_invalid_parameter_combination_exception(&self) -> bool
pub fn is_invalid_parameter_combination_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidParameterCombinationException
.
Sourcepub fn is_invalid_parameter_exception(&self) -> bool
pub fn is_invalid_parameter_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidParameterException
.
Sourcepub fn is_invalid_s3_bucket_name_exception(&self) -> bool
pub fn is_invalid_s3_bucket_name_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidS3BucketNameException
.
Sourcepub fn is_invalid_s3_prefix_exception(&self) -> bool
pub fn is_invalid_s3_prefix_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidS3PrefixException
.
Sourcepub fn is_invalid_sns_topic_name_exception(&self) -> bool
pub fn is_invalid_sns_topic_name_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidSnsTopicNameException
.
Sourcepub fn is_invalid_trail_name_exception(&self) -> bool
pub fn is_invalid_trail_name_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::InvalidTrailNameException
.
Sourcepub fn is_kms_exception(&self) -> bool
pub fn is_kms_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::KmsException
.
Sourcepub fn is_kms_key_disabled_exception(&self) -> bool
pub fn is_kms_key_disabled_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::KmsKeyDisabledException
.
Sourcepub fn is_kms_key_not_found_exception(&self) -> bool
pub fn is_kms_key_not_found_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::KmsKeyNotFoundException
.
Sourcepub fn is_no_management_account_slr_exists_exception(&self) -> bool
pub fn is_no_management_account_slr_exists_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::NoManagementAccountSlrExistsException
.
Sourcepub fn is_not_organization_master_account_exception(&self) -> bool
pub fn is_not_organization_master_account_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::NotOrganizationMasterAccountException
.
Sourcepub fn is_operation_not_permitted_exception(&self) -> bool
pub fn is_operation_not_permitted_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::OperationNotPermittedException
.
Sourcepub fn is_organization_not_in_all_features_mode_exception(&self) -> bool
pub fn is_organization_not_in_all_features_mode_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::OrganizationNotInAllFeaturesModeException
.
Sourcepub fn is_organizations_not_in_use_exception(&self) -> bool
pub fn is_organizations_not_in_use_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::OrganizationsNotInUseException
.
Sourcepub fn is_s3_bucket_does_not_exist_exception(&self) -> bool
pub fn is_s3_bucket_does_not_exist_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::S3BucketDoesNotExistException
.
Sourcepub fn is_throttling_exception(&self) -> bool
pub fn is_throttling_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::ThrottlingException
.
Sourcepub fn is_trail_not_found_exception(&self) -> bool
pub fn is_trail_not_found_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::TrailNotFoundException
.
Sourcepub fn is_trail_not_provided_exception(&self) -> bool
pub fn is_trail_not_provided_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::TrailNotProvidedException
.
Sourcepub fn is_unsupported_operation_exception(&self) -> bool
pub fn is_unsupported_operation_exception(&self) -> bool
Returns true
if the error kind is UpdateTrailError::UnsupportedOperationException
.
Trait Implementations§
Source§impl CreateUnhandledError for UpdateTrailError
impl CreateUnhandledError for UpdateTrailError
Source§fn create_unhandled_error(
source: Box<dyn Error + Send + Sync + 'static>,
meta: Option<ErrorMetadata>,
) -> Self
fn create_unhandled_error( source: Box<dyn Error + Send + Sync + 'static>, meta: Option<ErrorMetadata>, ) -> Self
source
and error metadata.Source§impl Debug for UpdateTrailError
impl Debug for UpdateTrailError
Source§impl Display for UpdateTrailError
impl Display for UpdateTrailError
Source§impl Error for UpdateTrailError
impl Error for UpdateTrailError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
Source§impl From<UpdateTrailError> for Error
impl From<UpdateTrailError> for Error
Source§fn from(err: UpdateTrailError) -> Self
fn from(err: UpdateTrailError) -> Self
Source§impl ProvideErrorKind for UpdateTrailError
impl ProvideErrorKind for UpdateTrailError
Source§impl ProvideErrorMetadata for UpdateTrailError
impl ProvideErrorMetadata for UpdateTrailError
Source§fn meta(&self) -> &ErrorMetadata
fn meta(&self) -> &ErrorMetadata
Source§impl RequestId for UpdateTrailError
impl RequestId for UpdateTrailError
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.Auto Trait Implementations§
impl Freeze for UpdateTrailError
impl !RefUnwindSafe for UpdateTrailError
impl Send for UpdateTrailError
impl Sync for UpdateTrailError
impl Unpin for UpdateTrailError
impl !UnwindSafe for UpdateTrailError
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>
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);