#[non_exhaustive]pub enum Error {
Show 49 variants
AlreadyExistsException(AlreadyExistsException),
CloudHsmClusterInUseException(CloudHsmClusterInUseException),
CloudHsmClusterInvalidConfigurationException(CloudHsmClusterInvalidConfigurationException),
CloudHsmClusterNotActiveException(CloudHsmClusterNotActiveException),
CloudHsmClusterNotFoundException(CloudHsmClusterNotFoundException),
CloudHsmClusterNotRelatedException(CloudHsmClusterNotRelatedException),
ConflictException(ConflictException),
CustomKeyStoreHasCmKsException(CustomKeyStoreHasCmKsException),
CustomKeyStoreInvalidStateException(CustomKeyStoreInvalidStateException),
CustomKeyStoreNameInUseException(CustomKeyStoreNameInUseException),
CustomKeyStoreNotFoundException(CustomKeyStoreNotFoundException),
DependencyTimeoutException(DependencyTimeoutException),
DisabledException(DisabledException),
DryRunOperationException(DryRunOperationException),
ExpiredImportTokenException(ExpiredImportTokenException),
IncorrectKeyException(IncorrectKeyException),
IncorrectKeyMaterialException(IncorrectKeyMaterialException),
IncorrectTrustAnchorException(IncorrectTrustAnchorException),
InvalidAliasNameException(InvalidAliasNameException),
InvalidArnException(InvalidArnException),
InvalidCiphertextException(InvalidCiphertextException),
InvalidGrantIdException(InvalidGrantIdException),
InvalidGrantTokenException(InvalidGrantTokenException),
InvalidImportTokenException(InvalidImportTokenException),
InvalidKeyUsageException(InvalidKeyUsageException),
InvalidMarkerException(InvalidMarkerException),
KmsInternalException(KmsInternalException),
KmsInvalidMacException(KmsInvalidMacException),
KmsInvalidSignatureException(KmsInvalidSignatureException),
KmsInvalidStateException(KmsInvalidStateException),
KeyUnavailableException(KeyUnavailableException),
LimitExceededException(LimitExceededException),
MalformedPolicyDocumentException(MalformedPolicyDocumentException),
NotFoundException(NotFoundException),
TagException(TagException),
UnsupportedOperationException(UnsupportedOperationException),
XksKeyAlreadyInUseException(XksKeyAlreadyInUseException),
XksKeyInvalidConfigurationException(XksKeyInvalidConfigurationException),
XksKeyNotFoundException(XksKeyNotFoundException),
XksProxyIncorrectAuthenticationCredentialException(XksProxyIncorrectAuthenticationCredentialException),
XksProxyInvalidConfigurationException(XksProxyInvalidConfigurationException),
XksProxyInvalidResponseException(XksProxyInvalidResponseException),
XksProxyUriEndpointInUseException(XksProxyUriEndpointInUseException),
XksProxyUriInUseException(XksProxyUriInUseException),
XksProxyUriUnreachableException(XksProxyUriUnreachableException),
XksProxyVpcEndpointServiceInUseException(XksProxyVpcEndpointServiceInUseException),
XksProxyVpcEndpointServiceInvalidConfigurationException(XksProxyVpcEndpointServiceInvalidConfigurationException),
XksProxyVpcEndpointServiceNotFoundException(XksProxyVpcEndpointServiceNotFoundException),
Unhandled(Unhandled),
}
Expand description
All possible error types for this service.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
AlreadyExistsException(AlreadyExistsException)
The request was rejected because it attempted to create a resource that already exists.
CloudHsmClusterInUseException(CloudHsmClusterInUseException)
The request was rejected because the specified CloudHSM cluster is already associated with an CloudHSM key store in the account, or it shares a backup history with an CloudHSM key store in the account. Each CloudHSM key store in the account must be associated with a different CloudHSM cluster.
CloudHSM clusters that share a backup history have the same cluster certificate. To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters operation.
CloudHsmClusterInvalidConfigurationException(CloudHsmClusterInvalidConfigurationException)
The request was rejected because the associated CloudHSM cluster did not meet the configuration requirements for an CloudHSM key store.
-
The CloudHSM cluster must be configured with private subnets in at least two different Availability Zones in the Region.
-
The security group for the cluster (cloudhsm-cluster-
-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the CloudHSM cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation. -
The CloudHSM cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the CloudHSM CreateHsm operation.
For the
CreateCustomKeyStore
,UpdateCustomKeyStore
, andCreateKey
operations, the CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For theConnectCustomKeyStore
operation, the CloudHSM must contain at least one active HSM.
For information about the requirements for an CloudHSM cluster that is associated with an CloudHSM key store, see Assemble the Prerequisites in the Key Management Service Developer Guide. For information about creating a private subnet for an CloudHSM cluster, see Create a Private Subnet in the CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the CloudHSM User Guide .
CloudHsmClusterNotActiveException(CloudHsmClusterNotActiveException)
The request was rejected because the CloudHSM cluster associated with the CloudHSM key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the CloudHSM User Guide.
CloudHsmClusterNotFoundException(CloudHsmClusterNotFoundException)
The request was rejected because KMS cannot find the CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.
CloudHsmClusterNotRelatedException(CloudHsmClusterNotRelatedException)
The request was rejected because the specified CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster for an CloudHSM key store.
Specify an CloudHSM cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.
CloudHSM clusters that share a backup history have the same cluster certificate. To view the cluster certificate of an CloudHSM cluster, use the DescribeClusters operation.
ConflictException(ConflictException)
The request was rejected because an automatic rotation of this key is currently in progress or scheduled to begin within the next 20 minutes.
CustomKeyStoreHasCmKsException(CustomKeyStoreHasCmKsException)
The request was rejected because the custom key store contains KMS keys. After verifying that you do not need to use the KMS keys, use the ScheduleKeyDeletion
operation to delete the KMS keys. After they are deleted, you can delete the custom key store.
CustomKeyStoreInvalidStateException(CustomKeyStoreInvalidStateException)
The request was rejected because of the ConnectionState
of the custom key store. To get the ConnectionState
of a custom key store, use the DescribeCustomKeyStores
operation.
This exception is thrown under the following conditions:
-
You requested the
ConnectCustomKeyStore
operation on a custom key store with aConnectionState
ofDISCONNECTING
orFAILED
. This operation is valid for all otherConnectionState
values. To reconnect a custom key store in aFAILED
state, disconnect it (DisconnectCustomKeyStore
), then connect it (ConnectCustomKeyStore
). -
You requested the
CreateKey
operation in a custom key store that is not connected. This operations is valid only when the custom key storeConnectionState
isCONNECTED
. -
You requested the
DisconnectCustomKeyStore
operation on a custom key store with aConnectionState
ofDISCONNECTING
orDISCONNECTED
. This operation is valid for all otherConnectionState
values. -
You requested the
UpdateCustomKeyStore
orDeleteCustomKeyStore
operation on a custom key store that is not disconnected. This operation is valid only when the custom key storeConnectionState
isDISCONNECTED
. -
You requested the
GenerateRandom
operation in an CloudHSM key store that is not connected. This operation is valid only when the CloudHSM key storeConnectionState
isCONNECTED
.
CustomKeyStoreNameInUseException(CustomKeyStoreNameInUseException)
The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.
CustomKeyStoreNotFoundException(CustomKeyStoreNotFoundException)
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
DependencyTimeoutException(DependencyTimeoutException)
The system timed out while trying to fulfill the request. You can retry the request.
DisabledException(DisabledException)
The request was rejected because the specified KMS key is not enabled.
DryRunOperationException(DryRunOperationException)
The request was rejected because the DryRun parameter was specified.
ExpiredImportTokenException(ExpiredImportTokenException)
The request was rejected because the specified import token is expired. Use GetParametersForImport
to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.
IncorrectKeyException(IncorrectKeyException)
The request was rejected because the specified KMS key cannot decrypt the data. The KeyId
in a Decrypt
request and the SourceKeyId
in a ReEncrypt
request must identify the same KMS key that was used to encrypt the ciphertext.
IncorrectKeyMaterialException(IncorrectKeyMaterialException)
The request was rejected because the key material in the request is, expired, invalid, or is not the same key material that was previously imported into this KMS key.
IncorrectTrustAnchorException(IncorrectTrustAnchorException)
The request was rejected because the trust anchor certificate in the request to create an CloudHSM key store is not the trust anchor certificate for the specified CloudHSM cluster.
When you initialize the CloudHSM cluster, you create the trust anchor certificate and save it in the customerCA.crt
file.
InvalidAliasNameException(InvalidAliasNameException)
The request was rejected because the specified alias name is not valid.
InvalidArnException(InvalidArnException)
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
InvalidCiphertextException(InvalidCiphertextException)
From the Decrypt
or ReEncrypt
operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.
From the ImportKeyMaterial
operation, the request was rejected because KMS could not decrypt the encrypted (wrapped) key material.
InvalidGrantIdException(InvalidGrantIdException)
The request was rejected because the specified GrantId
is not valid.
InvalidGrantTokenException(InvalidGrantTokenException)
The request was rejected because the specified grant token is not valid.
InvalidImportTokenException(InvalidImportTokenException)
The request was rejected because the provided import token is invalid or is associated with a different KMS key.
InvalidKeyUsageException(InvalidKeyUsageException)
The request was rejected for one of the following reasons:
-
The
KeyUsage
value of the KMS key is incompatible with the API operation. -
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key
(KeySpec
).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage
must be ENCRYPT_DECRYPT
. For signing and verifying messages, the KeyUsage
must be SIGN_VERIFY
. For generating and verifying message authentication codes (MACs), the KeyUsage
must be GENERATE_VERIFY_MAC
. For deriving key agreement secrets, the KeyUsage
must be KEY_AGREEMENT
. To find the KeyUsage
of a KMS key, use the DescribeKey
operation.
To find the encryption or signing algorithms supported for a particular KMS key, use the DescribeKey
operation.
InvalidMarkerException(InvalidMarkerException)
The request was rejected because the marker that specifies where pagination should next begin is not valid.
KmsInternalException(KmsInternalException)
The request was rejected because an internal exception occurred. The request can be retried.
KmsInvalidMacException(KmsInvalidMacException)
The request was rejected because the HMAC verification failed. HMAC verification fails when the HMAC computed by using the specified message, HMAC KMS key, and MAC algorithm does not match the HMAC specified in the request.
KmsInvalidSignatureException(KmsInvalidSignatureException)
The request was rejected because the signature verification failed. Signature verification fails when it cannot confirm that signature was produced by signing the specified message with the specified KMS key and signing algorithm.
KmsInvalidStateException(KmsInvalidStateException)
The request was rejected because the state of the specified resource is not valid for this request.
This exceptions means one of the following:
-
The key state of the KMS key is not compatible with the operation.
To find the key state, use the
DescribeKey
operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide . -
For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.
The request was rejected because the specified KMS key was not available. You can retry the request.
LimitExceededException(LimitExceededException)
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
MalformedPolicyDocumentException(MalformedPolicyDocumentException)
The request was rejected because the specified policy is not syntactically or semantically correct.
NotFoundException(NotFoundException)
The request was rejected because the specified entity or resource could not be found.
TagException(TagException)
The request was rejected because one or more tags are not valid.
UnsupportedOperationException(UnsupportedOperationException)
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
XksKeyAlreadyInUseException(XksKeyAlreadyInUseException)
The request was rejected because the (XksKeyId
) is already associated with another KMS key in this external key store. Each KMS key in an external key store must be associated with a different external key.
XksKeyInvalidConfigurationException(XksKeyInvalidConfigurationException)
The request was rejected because the external key specified by the XksKeyId
parameter did not meet the configuration requirements for an external key store.
The external key must be an AES-256 symmetric key that is enabled and performs encryption and decryption.
XksKeyNotFoundException(XksKeyNotFoundException)
The request was rejected because the external key store proxy could not find the external key. This exception is thrown when the value of the XksKeyId
parameter doesn't identify a key in the external key manager associated with the external key proxy.
Verify that the XksKeyId
represents an existing key in the external key manager. Use the key identifier that the external key store proxy uses to identify the key. For details, see the documentation provided with your external key store proxy or key manager.
XksProxyIncorrectAuthenticationCredentialException(XksProxyIncorrectAuthenticationCredentialException)
The request was rejected because the proxy credentials failed to authenticate to the specified external key store proxy. The specified external key store proxy rejected a status request from KMS due to invalid credentials. This can indicate an error in the credentials or in the identification of the external key store proxy.
XksProxyInvalidConfigurationException(XksProxyInvalidConfigurationException)
The request was rejected because the external key store proxy is not configured correctly. To identify the cause, see the error message that accompanies the exception.
XksProxyInvalidResponseException(XksProxyInvalidResponseException)
KMS cannot interpret the response it received from the external key store proxy. The problem might be a poorly constructed response, but it could also be a transient network issue. If you see this error repeatedly, report it to the proxy vendor.
XksProxyUriEndpointInUseException(XksProxyUriEndpointInUseException)
The request was rejected because the XksProxyUriEndpoint
is already associated with another external key store in this Amazon Web Services Region. To identify the cause, see the error message that accompanies the exception.
XksProxyUriInUseException(XksProxyUriInUseException)
The request was rejected because the concatenation of the XksProxyUriEndpoint
and XksProxyUriPath
is already associated with another external key store in this Amazon Web Services Region. Each external key store in a Region must use a unique external key store proxy API address.
XksProxyUriUnreachableException(XksProxyUriUnreachableException)
KMS was unable to reach the specified XksProxyUriPath
. The path must be reachable before you create the external key store or update its settings.
This exception is also thrown when the external key store proxy response to a GetHealthStatus
request indicates that all external key manager instances are unavailable.
XksProxyVpcEndpointServiceInUseException(XksProxyVpcEndpointServiceInUseException)
The request was rejected because the specified Amazon VPC endpoint service is already associated with another external key store in this Amazon Web Services Region. Each external key store in a Region must use a different Amazon VPC endpoint service.
XksProxyVpcEndpointServiceInvalidConfigurationException(XksProxyVpcEndpointServiceInvalidConfigurationException)
The request was rejected because the Amazon VPC endpoint service configuration does not fulfill the requirements for an external key store. To identify the cause, see the error message that accompanies the exception and review the requirements for Amazon VPC endpoint service connectivity for an external key store.
XksProxyVpcEndpointServiceNotFoundException(XksProxyVpcEndpointServiceNotFoundException)
The request was rejected because KMS could not find the specified VPC endpoint service. Use DescribeCustomKeyStores
to verify the VPC endpoint service name for the external key store. Also, confirm that the Allow principals
list for the VPC endpoint service includes the KMS service principal for the Region, such as cks.kms.us-east-1.amazonaws.com
.
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).
Trait Implementations§
Source§impl Error for Error
impl Error for Error
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<BuildError> for Error
impl From<BuildError> for Error
Source§fn from(value: BuildError) -> Self
fn from(value: BuildError) -> Self
Source§impl From<CancelKeyDeletionError> for Error
impl From<CancelKeyDeletionError> for Error
Source§fn from(err: CancelKeyDeletionError) -> Self
fn from(err: CancelKeyDeletionError) -> Self
Source§impl From<ConnectCustomKeyStoreError> for Error
impl From<ConnectCustomKeyStoreError> for Error
Source§fn from(err: ConnectCustomKeyStoreError) -> Self
fn from(err: ConnectCustomKeyStoreError) -> Self
Source§impl From<CreateAliasError> for Error
impl From<CreateAliasError> for Error
Source§fn from(err: CreateAliasError) -> Self
fn from(err: CreateAliasError) -> Self
Source§impl From<CreateCustomKeyStoreError> for Error
impl From<CreateCustomKeyStoreError> for Error
Source§fn from(err: CreateCustomKeyStoreError) -> Self
fn from(err: CreateCustomKeyStoreError) -> Self
Source§impl From<CreateGrantError> for Error
impl From<CreateGrantError> for Error
Source§fn from(err: CreateGrantError) -> Self
fn from(err: CreateGrantError) -> Self
Source§impl From<CreateKeyError> for Error
impl From<CreateKeyError> for Error
Source§fn from(err: CreateKeyError) -> Self
fn from(err: CreateKeyError) -> Self
Source§impl From<DecryptError> for Error
impl From<DecryptError> for Error
Source§fn from(err: DecryptError) -> Self
fn from(err: DecryptError) -> Self
Source§impl From<DeleteAliasError> for Error
impl From<DeleteAliasError> for Error
Source§fn from(err: DeleteAliasError) -> Self
fn from(err: DeleteAliasError) -> Self
Source§impl From<DeleteCustomKeyStoreError> for Error
impl From<DeleteCustomKeyStoreError> for Error
Source§fn from(err: DeleteCustomKeyStoreError) -> Self
fn from(err: DeleteCustomKeyStoreError) -> Self
Source§impl From<DeleteImportedKeyMaterialError> for Error
impl From<DeleteImportedKeyMaterialError> for Error
Source§fn from(err: DeleteImportedKeyMaterialError) -> Self
fn from(err: DeleteImportedKeyMaterialError) -> Self
Source§fn from(err: DeriveSharedSecretError) -> Self
fn from(err: DeriveSharedSecretError) -> Self
Source§impl From<DescribeCustomKeyStoresError> for Error
impl From<DescribeCustomKeyStoresError> for Error
Source§fn from(err: DescribeCustomKeyStoresError) -> Self
fn from(err: DescribeCustomKeyStoresError) -> Self
Source§impl From<DescribeKeyError> for Error
impl From<DescribeKeyError> for Error
Source§fn from(err: DescribeKeyError) -> Self
fn from(err: DescribeKeyError) -> Self
Source§impl From<DisableKeyError> for Error
impl From<DisableKeyError> for Error
Source§fn from(err: DisableKeyError) -> Self
fn from(err: DisableKeyError) -> Self
Source§impl From<DisableKeyRotationError> for Error
impl From<DisableKeyRotationError> for Error
Source§fn from(err: DisableKeyRotationError) -> Self
fn from(err: DisableKeyRotationError) -> Self
Source§impl From<DisconnectCustomKeyStoreError> for Error
impl From<DisconnectCustomKeyStoreError> for Error
Source§fn from(err: DisconnectCustomKeyStoreError) -> Self
fn from(err: DisconnectCustomKeyStoreError) -> Self
Source§impl From<EnableKeyError> for Error
impl From<EnableKeyError> for Error
Source§fn from(err: EnableKeyError) -> Self
fn from(err: EnableKeyError) -> Self
Source§impl From<EnableKeyRotationError> for Error
impl From<EnableKeyRotationError> for Error
Source§fn from(err: EnableKeyRotationError) -> Self
fn from(err: EnableKeyRotationError) -> Self
Source§impl From<EncryptError> for Error
impl From<EncryptError> for Error
Source§fn from(err: EncryptError) -> Self
fn from(err: EncryptError) -> Self
Source§impl From<GenerateDataKeyError> for Error
impl From<GenerateDataKeyError> for Error
Source§fn from(err: GenerateDataKeyError) -> Self
fn from(err: GenerateDataKeyError) -> Self
Source§impl From<GenerateDataKeyPairError> for Error
impl From<GenerateDataKeyPairError> for Error
Source§fn from(err: GenerateDataKeyPairError) -> Self
fn from(err: GenerateDataKeyPairError) -> Self
Source§impl From<GenerateDataKeyPairWithoutPlaintextError> for Error
impl From<GenerateDataKeyPairWithoutPlaintextError> for Error
Source§fn from(err: GenerateDataKeyPairWithoutPlaintextError) -> Self
fn from(err: GenerateDataKeyPairWithoutPlaintextError) -> Self
Source§impl From<GenerateDataKeyWithoutPlaintextError> for Error
impl From<GenerateDataKeyWithoutPlaintextError> for Error
Source§fn from(err: GenerateDataKeyWithoutPlaintextError) -> Self
fn from(err: GenerateDataKeyWithoutPlaintextError) -> Self
Source§impl From<GenerateMacError> for Error
impl From<GenerateMacError> for Error
Source§fn from(err: GenerateMacError) -> Self
fn from(err: GenerateMacError) -> Self
Source§impl From<GenerateRandomError> for Error
impl From<GenerateRandomError> for Error
Source§fn from(err: GenerateRandomError) -> Self
fn from(err: GenerateRandomError) -> Self
Source§impl From<GetKeyPolicyError> for Error
impl From<GetKeyPolicyError> for Error
Source§fn from(err: GetKeyPolicyError) -> Self
fn from(err: GetKeyPolicyError) -> Self
Source§impl From<GetKeyRotationStatusError> for Error
impl From<GetKeyRotationStatusError> for Error
Source§fn from(err: GetKeyRotationStatusError) -> Self
fn from(err: GetKeyRotationStatusError) -> Self
Source§impl From<GetParametersForImportError> for Error
impl From<GetParametersForImportError> for Error
Source§fn from(err: GetParametersForImportError) -> Self
fn from(err: GetParametersForImportError) -> Self
Source§impl From<GetPublicKeyError> for Error
impl From<GetPublicKeyError> for Error
Source§fn from(err: GetPublicKeyError) -> Self
fn from(err: GetPublicKeyError) -> Self
Source§impl From<ImportKeyMaterialError> for Error
impl From<ImportKeyMaterialError> for Error
Source§fn from(err: ImportKeyMaterialError) -> Self
fn from(err: ImportKeyMaterialError) -> Self
Source§impl From<ListAliasesError> for Error
impl From<ListAliasesError> for Error
Source§fn from(err: ListAliasesError) -> Self
fn from(err: ListAliasesError) -> Self
Source§impl From<ListGrantsError> for Error
impl From<ListGrantsError> for Error
Source§fn from(err: ListGrantsError) -> Self
fn from(err: ListGrantsError) -> Self
Source§impl From<ListKeyPoliciesError> for Error
impl From<ListKeyPoliciesError> for Error
Source§fn from(err: ListKeyPoliciesError) -> Self
fn from(err: ListKeyPoliciesError) -> Self
Source§impl From<ListKeyRotationsError> for Error
impl From<ListKeyRotationsError> for Error
Source§fn from(err: ListKeyRotationsError) -> Self
fn from(err: ListKeyRotationsError) -> Self
Source§impl From<ListKeysError> for Error
impl From<ListKeysError> for Error
Source§fn from(err: ListKeysError) -> Self
fn from(err: ListKeysError) -> Self
Source§impl From<ListResourceTagsError> for Error
impl From<ListResourceTagsError> for Error
Source§fn from(err: ListResourceTagsError) -> Self
fn from(err: ListResourceTagsError) -> Self
Source§impl From<ListRetirableGrantsError> for Error
impl From<ListRetirableGrantsError> for Error
Source§fn from(err: ListRetirableGrantsError) -> Self
fn from(err: ListRetirableGrantsError) -> Self
Source§impl From<PutKeyPolicyError> for Error
impl From<PutKeyPolicyError> for Error
Source§fn from(err: PutKeyPolicyError) -> Self
fn from(err: PutKeyPolicyError) -> Self
Source§impl From<ReEncryptError> for Error
impl From<ReEncryptError> for Error
Source§fn from(err: ReEncryptError) -> Self
fn from(err: ReEncryptError) -> Self
Source§impl From<ReplicateKeyError> for Error
impl From<ReplicateKeyError> for Error
Source§fn from(err: ReplicateKeyError) -> Self
fn from(err: ReplicateKeyError) -> Self
Source§impl From<RetireGrantError> for Error
impl From<RetireGrantError> for Error
Source§fn from(err: RetireGrantError) -> Self
fn from(err: RetireGrantError) -> Self
Source§impl From<RevokeGrantError> for Error
impl From<RevokeGrantError> for Error
Source§fn from(err: RevokeGrantError) -> Self
fn from(err: RevokeGrantError) -> Self
Source§impl From<RotateKeyOnDemandError> for Error
impl From<RotateKeyOnDemandError> for Error
Source§fn from(err: RotateKeyOnDemandError) -> Self
fn from(err: RotateKeyOnDemandError) -> Self
Source§impl From<ScheduleKeyDeletionError> for Error
impl From<ScheduleKeyDeletionError> for Error
Source§fn from(err: ScheduleKeyDeletionError) -> Self
fn from(err: ScheduleKeyDeletionError) -> Self
Source§impl<R> From<SdkError<CancelKeyDeletionError, R>> for Error
impl<R> From<SdkError<CancelKeyDeletionError, R>> for Error
Source§fn from(err: SdkError<CancelKeyDeletionError, R>) -> Self
fn from(err: SdkError<CancelKeyDeletionError, R>) -> Self
Source§impl<R> From<SdkError<ConnectCustomKeyStoreError, R>> for Error
impl<R> From<SdkError<ConnectCustomKeyStoreError, R>> for Error
Source§fn from(err: SdkError<ConnectCustomKeyStoreError, R>) -> Self
fn from(err: SdkError<ConnectCustomKeyStoreError, R>) -> Self
Source§impl<R> From<SdkError<CreateAliasError, R>> for Error
impl<R> From<SdkError<CreateAliasError, R>> for Error
Source§fn from(err: SdkError<CreateAliasError, R>) -> Self
fn from(err: SdkError<CreateAliasError, R>) -> Self
Source§impl<R> From<SdkError<CreateCustomKeyStoreError, R>> for Error
impl<R> From<SdkError<CreateCustomKeyStoreError, R>> for Error
Source§fn from(err: SdkError<CreateCustomKeyStoreError, R>) -> Self
fn from(err: SdkError<CreateCustomKeyStoreError, R>) -> Self
Source§impl<R> From<SdkError<CreateGrantError, R>> for Error
impl<R> From<SdkError<CreateGrantError, R>> for Error
Source§fn from(err: SdkError<CreateGrantError, R>) -> Self
fn from(err: SdkError<CreateGrantError, R>) -> Self
Source§impl<R> From<SdkError<CreateKeyError, R>> for Error
impl<R> From<SdkError<CreateKeyError, R>> for Error
Source§fn from(err: SdkError<CreateKeyError, R>) -> Self
fn from(err: SdkError<CreateKeyError, R>) -> Self
Source§impl<R> From<SdkError<DecryptError, R>> for Error
impl<R> From<SdkError<DecryptError, R>> for Error
Source§fn from(err: SdkError<DecryptError, R>) -> Self
fn from(err: SdkError<DecryptError, R>) -> Self
Source§impl<R> From<SdkError<DeleteAliasError, R>> for Error
impl<R> From<SdkError<DeleteAliasError, R>> for Error
Source§fn from(err: SdkError<DeleteAliasError, R>) -> Self
fn from(err: SdkError<DeleteAliasError, R>) -> Self
Source§impl<R> From<SdkError<DeleteCustomKeyStoreError, R>> for Error
impl<R> From<SdkError<DeleteCustomKeyStoreError, R>> for Error
Source§fn from(err: SdkError<DeleteCustomKeyStoreError, R>) -> Self
fn from(err: SdkError<DeleteCustomKeyStoreError, R>) -> Self
Source§impl<R> From<SdkError<DeleteImportedKeyMaterialError, R>> for Error
impl<R> From<SdkError<DeleteImportedKeyMaterialError, R>> for Error
Source§fn from(err: SdkError<DeleteImportedKeyMaterialError, R>) -> Self
fn from(err: SdkError<DeleteImportedKeyMaterialError, R>) -> Self
Source§fn from(err: SdkError<DeriveSharedSecretError, R>) -> Self
fn from(err: SdkError<DeriveSharedSecretError, R>) -> Self
Source§impl<R> From<SdkError<DescribeCustomKeyStoresError, R>> for Error
impl<R> From<SdkError<DescribeCustomKeyStoresError, R>> for Error
Source§fn from(err: SdkError<DescribeCustomKeyStoresError, R>) -> Self
fn from(err: SdkError<DescribeCustomKeyStoresError, R>) -> Self
Source§impl<R> From<SdkError<DescribeKeyError, R>> for Error
impl<R> From<SdkError<DescribeKeyError, R>> for Error
Source§fn from(err: SdkError<DescribeKeyError, R>) -> Self
fn from(err: SdkError<DescribeKeyError, R>) -> Self
Source§impl<R> From<SdkError<DisableKeyError, R>> for Error
impl<R> From<SdkError<DisableKeyError, R>> for Error
Source§fn from(err: SdkError<DisableKeyError, R>) -> Self
fn from(err: SdkError<DisableKeyError, R>) -> Self
Source§impl<R> From<SdkError<DisableKeyRotationError, R>> for Error
impl<R> From<SdkError<DisableKeyRotationError, R>> for Error
Source§fn from(err: SdkError<DisableKeyRotationError, R>) -> Self
fn from(err: SdkError<DisableKeyRotationError, R>) -> Self
Source§impl<R> From<SdkError<DisconnectCustomKeyStoreError, R>> for Error
impl<R> From<SdkError<DisconnectCustomKeyStoreError, R>> for Error
Source§fn from(err: SdkError<DisconnectCustomKeyStoreError, R>) -> Self
fn from(err: SdkError<DisconnectCustomKeyStoreError, R>) -> Self
Source§impl<R> From<SdkError<EnableKeyError, R>> for Error
impl<R> From<SdkError<EnableKeyError, R>> for Error
Source§fn from(err: SdkError<EnableKeyError, R>) -> Self
fn from(err: SdkError<EnableKeyError, R>) -> Self
Source§impl<R> From<SdkError<EnableKeyRotationError, R>> for Error
impl<R> From<SdkError<EnableKeyRotationError, R>> for Error
Source§fn from(err: SdkError<EnableKeyRotationError, R>) -> Self
fn from(err: SdkError<EnableKeyRotationError, R>) -> Self
Source§impl<R> From<SdkError<EncryptError, R>> for Error
impl<R> From<SdkError<EncryptError, R>> for Error
Source§fn from(err: SdkError<EncryptError, R>) -> Self
fn from(err: SdkError<EncryptError, R>) -> Self
Source§impl<R> From<SdkError<GenerateDataKeyError, R>> for Error
impl<R> From<SdkError<GenerateDataKeyError, R>> for Error
Source§fn from(err: SdkError<GenerateDataKeyError, R>) -> Self
fn from(err: SdkError<GenerateDataKeyError, R>) -> Self
Source§impl<R> From<SdkError<GenerateDataKeyPairError, R>> for Error
impl<R> From<SdkError<GenerateDataKeyPairError, R>> for Error
Source§fn from(err: SdkError<GenerateDataKeyPairError, R>) -> Self
fn from(err: SdkError<GenerateDataKeyPairError, R>) -> Self
Source§impl<R> From<SdkError<GenerateDataKeyPairWithoutPlaintextError, R>> for Error
impl<R> From<SdkError<GenerateDataKeyPairWithoutPlaintextError, R>> for Error
Source§fn from(err: SdkError<GenerateDataKeyPairWithoutPlaintextError, R>) -> Self
fn from(err: SdkError<GenerateDataKeyPairWithoutPlaintextError, R>) -> Self
Source§impl<R> From<SdkError<GenerateDataKeyWithoutPlaintextError, R>> for Error
impl<R> From<SdkError<GenerateDataKeyWithoutPlaintextError, R>> for Error
Source§fn from(err: SdkError<GenerateDataKeyWithoutPlaintextError, R>) -> Self
fn from(err: SdkError<GenerateDataKeyWithoutPlaintextError, R>) -> Self
Source§impl<R> From<SdkError<GenerateMacError, R>> for Error
impl<R> From<SdkError<GenerateMacError, R>> for Error
Source§fn from(err: SdkError<GenerateMacError, R>) -> Self
fn from(err: SdkError<GenerateMacError, R>) -> Self
Source§impl<R> From<SdkError<GenerateRandomError, R>> for Error
impl<R> From<SdkError<GenerateRandomError, R>> for Error
Source§fn from(err: SdkError<GenerateRandomError, R>) -> Self
fn from(err: SdkError<GenerateRandomError, R>) -> Self
Source§impl<R> From<SdkError<GetKeyPolicyError, R>> for Error
impl<R> From<SdkError<GetKeyPolicyError, R>> for Error
Source§fn from(err: SdkError<GetKeyPolicyError, R>) -> Self
fn from(err: SdkError<GetKeyPolicyError, R>) -> Self
Source§impl<R> From<SdkError<GetKeyRotationStatusError, R>> for Error
impl<R> From<SdkError<GetKeyRotationStatusError, R>> for Error
Source§fn from(err: SdkError<GetKeyRotationStatusError, R>) -> Self
fn from(err: SdkError<GetKeyRotationStatusError, R>) -> Self
Source§impl<R> From<SdkError<GetParametersForImportError, R>> for Error
impl<R> From<SdkError<GetParametersForImportError, R>> for Error
Source§fn from(err: SdkError<GetParametersForImportError, R>) -> Self
fn from(err: SdkError<GetParametersForImportError, R>) -> Self
Source§impl<R> From<SdkError<GetPublicKeyError, R>> for Error
impl<R> From<SdkError<GetPublicKeyError, R>> for Error
Source§fn from(err: SdkError<GetPublicKeyError, R>) -> Self
fn from(err: SdkError<GetPublicKeyError, R>) -> Self
Source§impl<R> From<SdkError<ImportKeyMaterialError, R>> for Error
impl<R> From<SdkError<ImportKeyMaterialError, R>> for Error
Source§fn from(err: SdkError<ImportKeyMaterialError, R>) -> Self
fn from(err: SdkError<ImportKeyMaterialError, R>) -> Self
Source§impl<R> From<SdkError<ListAliasesError, R>> for Error
impl<R> From<SdkError<ListAliasesError, R>> for Error
Source§fn from(err: SdkError<ListAliasesError, R>) -> Self
fn from(err: SdkError<ListAliasesError, R>) -> Self
Source§impl<R> From<SdkError<ListGrantsError, R>> for Error
impl<R> From<SdkError<ListGrantsError, R>> for Error
Source§fn from(err: SdkError<ListGrantsError, R>) -> Self
fn from(err: SdkError<ListGrantsError, R>) -> Self
Source§impl<R> From<SdkError<ListKeyPoliciesError, R>> for Error
impl<R> From<SdkError<ListKeyPoliciesError, R>> for Error
Source§fn from(err: SdkError<ListKeyPoliciesError, R>) -> Self
fn from(err: SdkError<ListKeyPoliciesError, R>) -> Self
Source§impl<R> From<SdkError<ListKeyRotationsError, R>> for Error
impl<R> From<SdkError<ListKeyRotationsError, R>> for Error
Source§fn from(err: SdkError<ListKeyRotationsError, R>) -> Self
fn from(err: SdkError<ListKeyRotationsError, R>) -> Self
Source§impl<R> From<SdkError<ListKeysError, R>> for Error
impl<R> From<SdkError<ListKeysError, R>> for Error
Source§fn from(err: SdkError<ListKeysError, R>) -> Self
fn from(err: SdkError<ListKeysError, R>) -> Self
Source§impl<R> From<SdkError<ListResourceTagsError, R>> for Error
impl<R> From<SdkError<ListResourceTagsError, R>> for Error
Source§fn from(err: SdkError<ListResourceTagsError, R>) -> Self
fn from(err: SdkError<ListResourceTagsError, R>) -> Self
Source§impl<R> From<SdkError<ListRetirableGrantsError, R>> for Error
impl<R> From<SdkError<ListRetirableGrantsError, R>> for Error
Source§fn from(err: SdkError<ListRetirableGrantsError, R>) -> Self
fn from(err: SdkError<ListRetirableGrantsError, R>) -> Self
Source§impl<R> From<SdkError<PutKeyPolicyError, R>> for Error
impl<R> From<SdkError<PutKeyPolicyError, R>> for Error
Source§fn from(err: SdkError<PutKeyPolicyError, R>) -> Self
fn from(err: SdkError<PutKeyPolicyError, R>) -> Self
Source§impl<R> From<SdkError<ReEncryptError, R>> for Error
impl<R> From<SdkError<ReEncryptError, R>> for Error
Source§fn from(err: SdkError<ReEncryptError, R>) -> Self
fn from(err: SdkError<ReEncryptError, R>) -> Self
Source§impl<R> From<SdkError<ReplicateKeyError, R>> for Error
impl<R> From<SdkError<ReplicateKeyError, R>> for Error
Source§fn from(err: SdkError<ReplicateKeyError, R>) -> Self
fn from(err: SdkError<ReplicateKeyError, R>) -> Self
Source§impl<R> From<SdkError<RetireGrantError, R>> for Error
impl<R> From<SdkError<RetireGrantError, R>> for Error
Source§fn from(err: SdkError<RetireGrantError, R>) -> Self
fn from(err: SdkError<RetireGrantError, R>) -> Self
Source§impl<R> From<SdkError<RevokeGrantError, R>> for Error
impl<R> From<SdkError<RevokeGrantError, R>> for Error
Source§fn from(err: SdkError<RevokeGrantError, R>) -> Self
fn from(err: SdkError<RevokeGrantError, R>) -> Self
Source§impl<R> From<SdkError<RotateKeyOnDemandError, R>> for Error
impl<R> From<SdkError<RotateKeyOnDemandError, R>> for Error
Source§fn from(err: SdkError<RotateKeyOnDemandError, R>) -> Self
fn from(err: SdkError<RotateKeyOnDemandError, R>) -> Self
Source§impl<R> From<SdkError<ScheduleKeyDeletionError, R>> for Error
impl<R> From<SdkError<ScheduleKeyDeletionError, R>> for Error
Source§fn from(err: SdkError<ScheduleKeyDeletionError, R>) -> Self
fn from(err: SdkError<ScheduleKeyDeletionError, R>) -> Self
Source§impl<R> From<SdkError<TagResourceError, R>> for Error
impl<R> From<SdkError<TagResourceError, R>> for Error
Source§fn from(err: SdkError<TagResourceError, R>) -> Self
fn from(err: SdkError<TagResourceError, R>) -> Self
Source§impl<R> From<SdkError<UntagResourceError, R>> for Error
impl<R> From<SdkError<UntagResourceError, R>> for Error
Source§fn from(err: SdkError<UntagResourceError, R>) -> Self
fn from(err: SdkError<UntagResourceError, R>) -> Self
Source§impl<R> From<SdkError<UpdateAliasError, R>> for Error
impl<R> From<SdkError<UpdateAliasError, R>> for Error
Source§fn from(err: SdkError<UpdateAliasError, R>) -> Self
fn from(err: SdkError<UpdateAliasError, R>) -> Self
Source§impl<R> From<SdkError<UpdateCustomKeyStoreError, R>> for Error
impl<R> From<SdkError<UpdateCustomKeyStoreError, R>> for Error
Source§fn from(err: SdkError<UpdateCustomKeyStoreError, R>) -> Self
fn from(err: SdkError<UpdateCustomKeyStoreError, R>) -> Self
Source§impl<R> From<SdkError<UpdateKeyDescriptionError, R>> for Error
impl<R> From<SdkError<UpdateKeyDescriptionError, R>> for Error
Source§fn from(err: SdkError<UpdateKeyDescriptionError, R>) -> Self
fn from(err: SdkError<UpdateKeyDescriptionError, R>) -> Self
Source§impl<R> From<SdkError<UpdatePrimaryRegionError, R>> for Error
impl<R> From<SdkError<UpdatePrimaryRegionError, R>> for Error
Source§fn from(err: SdkError<UpdatePrimaryRegionError, R>) -> Self
fn from(err: SdkError<UpdatePrimaryRegionError, R>) -> Self
Source§impl<R> From<SdkError<VerifyError, R>> for Error
impl<R> From<SdkError<VerifyError, R>> for Error
Source§fn from(err: SdkError<VerifyError, R>) -> Self
fn from(err: SdkError<VerifyError, R>) -> Self
Source§impl<R> From<SdkError<VerifyMacError, R>> for Error
impl<R> From<SdkError<VerifyMacError, R>> for Error
Source§fn from(err: SdkError<VerifyMacError, R>) -> Self
fn from(err: SdkError<VerifyMacError, R>) -> Self
Source§impl From<TagResourceError> for Error
impl From<TagResourceError> for Error
Source§fn from(err: TagResourceError) -> Self
fn from(err: TagResourceError) -> Self
Source§impl From<UntagResourceError> for Error
impl From<UntagResourceError> for Error
Source§fn from(err: UntagResourceError) -> Self
fn from(err: UntagResourceError) -> Self
Source§impl From<UpdateAliasError> for Error
impl From<UpdateAliasError> for Error
Source§fn from(err: UpdateAliasError) -> Self
fn from(err: UpdateAliasError) -> Self
Source§impl From<UpdateCustomKeyStoreError> for Error
impl From<UpdateCustomKeyStoreError> for Error
Source§fn from(err: UpdateCustomKeyStoreError) -> Self
fn from(err: UpdateCustomKeyStoreError) -> Self
Source§impl From<UpdateKeyDescriptionError> for Error
impl From<UpdateKeyDescriptionError> for Error
Source§fn from(err: UpdateKeyDescriptionError) -> Self
fn from(err: UpdateKeyDescriptionError) -> Self
Source§impl From<UpdatePrimaryRegionError> for Error
impl From<UpdatePrimaryRegionError> for Error
Source§fn from(err: UpdatePrimaryRegionError) -> Self
fn from(err: UpdatePrimaryRegionError) -> Self
Source§impl From<VerifyError> for Error
impl From<VerifyError> for Error
Source§fn from(err: VerifyError) -> Self
fn from(err: VerifyError) -> Self
Source§impl From<VerifyMacError> for Error
impl From<VerifyMacError> for Error
Source§fn from(err: VerifyMacError) -> Self
fn from(err: VerifyMacError) -> Self
Source§impl ProvideErrorMetadata for Error
impl ProvideErrorMetadata for Error
Source§fn meta(&self) -> &ErrorMetadata
fn meta(&self) -> &ErrorMetadata
Auto Trait Implementations§
impl Freeze for Error
impl !RefUnwindSafe for Error
impl Send for Error
impl Sync for Error
impl Unpin for Error
impl !UnwindSafe for Error
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);