Enum Error

Source
#[non_exhaustive]
pub enum Error {
Show 35 variants AuthorizationErrorException(AuthorizationErrorException), BatchEntryIdsNotDistinctException(BatchEntryIdsNotDistinctException), BatchRequestTooLongException(BatchRequestTooLongException), ConcurrentAccessException(ConcurrentAccessException), EmptyBatchRequestException(EmptyBatchRequestException), EndpointDisabledException(EndpointDisabledException), FilterPolicyLimitExceededException(FilterPolicyLimitExceededException), InternalErrorException(InternalErrorException), InvalidBatchEntryIdException(InvalidBatchEntryIdException), InvalidParameterException(InvalidParameterException), InvalidParameterValueException(InvalidParameterValueException), InvalidSecurityException(InvalidSecurityException), InvalidStateException(InvalidStateException), KmsAccessDeniedException(KmsAccessDeniedException), KmsDisabledException(KmsDisabledException), KmsInvalidStateException(KmsInvalidStateException), KmsNotFoundException(KmsNotFoundException), KmsOptInRequired(KmsOptInRequired), KmsThrottlingException(KmsThrottlingException), NotFoundException(NotFoundException), OptedOutException(OptedOutException), PlatformApplicationDisabledException(PlatformApplicationDisabledException), ReplayLimitExceededException(ReplayLimitExceededException), ResourceNotFoundException(ResourceNotFoundException), StaleTagException(StaleTagException), SubscriptionLimitExceededException(SubscriptionLimitExceededException), TagLimitExceededException(TagLimitExceededException), TagPolicyException(TagPolicyException), ThrottledException(ThrottledException), TooManyEntriesInBatchRequestException(TooManyEntriesInBatchRequestException), TopicLimitExceededException(TopicLimitExceededException), UserErrorException(UserErrorException), ValidationException(ValidationException), VerificationException(VerificationException), Unhandled(Unhandled),
}
Expand description

All possible error types for this service.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

AuthorizationErrorException(AuthorizationErrorException)

Indicates that the user has been denied access to the requested resource.

§

BatchEntryIdsNotDistinctException(BatchEntryIdsNotDistinctException)

Two or more batch entries in the request have the same Id.

§

BatchRequestTooLongException(BatchRequestTooLongException)

The length of all the batch messages put together is more than the limit.

§

ConcurrentAccessException(ConcurrentAccessException)

Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.

§

EmptyBatchRequestException(EmptyBatchRequestException)

The batch request doesn't contain any entries.

§

EndpointDisabledException(EndpointDisabledException)

Exception error indicating endpoint disabled.

§

FilterPolicyLimitExceededException(FilterPolicyLimitExceededException)

Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.

§

InternalErrorException(InternalErrorException)

Indicates an internal service error.

§

InvalidBatchEntryIdException(InvalidBatchEntryIdException)

The Id of a batch entry in a batch request doesn't abide by the specification.

§

InvalidParameterException(InvalidParameterException)

Indicates that a request parameter does not comply with the associated constraints.

§

InvalidParameterValueException(InvalidParameterValueException)

Indicates that a request parameter does not comply with the associated constraints.

§

InvalidSecurityException(InvalidSecurityException)

The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.

§

InvalidStateException(InvalidStateException)

Indicates that the specified state is not a valid state for an event source.

§

KmsAccessDeniedException(KmsAccessDeniedException)

The ciphertext references a key that doesn't exist or that you don't have access to.

§

KmsDisabledException(KmsDisabledException)

The request was rejected because the specified Amazon Web Services KMS key isn't enabled.

§

KmsInvalidStateException(KmsInvalidStateException)

The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide.

§

KmsNotFoundException(KmsNotFoundException)

The request was rejected because the specified entity or resource can't be found.

§

KmsOptInRequired(KmsOptInRequired)

The Amazon Web Services access key ID needs a subscription for the service.

§

KmsThrottlingException(KmsThrottlingException)

The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide.

§

NotFoundException(NotFoundException)

Indicates that the requested resource does not exist.

§

OptedOutException(OptedOutException)

Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out.

§

PlatformApplicationDisabledException(PlatformApplicationDisabledException)

Exception error indicating platform application disabled.

§

ReplayLimitExceededException(ReplayLimitExceededException)

Indicates that the request parameter has exceeded the maximum number of concurrent message replays.

§

ResourceNotFoundException(ResourceNotFoundException)

Can’t perform the action on the specified resource. Make sure that the resource exists.

§

StaleTagException(StaleTagException)

A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.

§

SubscriptionLimitExceededException(SubscriptionLimitExceededException)

Indicates that the customer already owns the maximum allowed number of subscriptions.

§

TagLimitExceededException(TagLimitExceededException)

Can't add more than 50 tags to a topic.

§

TagPolicyException(TagPolicyException)

The request doesn't comply with the IAM tag policy. Correct your request and then retry it.

§

ThrottledException(ThrottledException)

Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.

§

TooManyEntriesInBatchRequestException(TooManyEntriesInBatchRequestException)

The batch request contains more entries than permissible.

§

TopicLimitExceededException(TopicLimitExceededException)

Indicates that the customer already owns the maximum allowed number of topics.

§

UserErrorException(UserErrorException)

Indicates that a request parameter does not comply with the associated constraints.

§

ValidationException(ValidationException)

Indicates that a parameter in the request is invalid.

§

VerificationException(VerificationException)

Indicates that the one-time password (OTP) used for verification is invalid.

§

Unhandled(Unhandled)

👎Deprecated: Matching 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 Debug for Error

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Error for Error

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<AddPermissionError> for Error

Source§

fn from(err: AddPermissionError) -> Self

Converts to this type from the input type.
Source§

impl From<BuildError> for Error

Source§

fn from(value: BuildError) -> Self

Converts to this type from the input type.
Source§

impl From<CheckIfPhoneNumberIsOptedOutError> for Error

Source§

fn from(err: CheckIfPhoneNumberIsOptedOutError) -> Self

Converts to this type from the input type.
Source§

impl From<ConfirmSubscriptionError> for Error

Source§

fn from(err: ConfirmSubscriptionError) -> Self

Converts to this type from the input type.
Source§

impl From<CreatePlatformApplicationError> for Error

Source§

fn from(err: CreatePlatformApplicationError) -> Self

Converts to this type from the input type.
Source§

impl From<CreatePlatformEndpointError> for Error

Source§

fn from(err: CreatePlatformEndpointError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateSMSSandboxPhoneNumberError> for Error

Source§

fn from(err: CreateSMSSandboxPhoneNumberError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateTopicError> for Error

Source§

fn from(err: CreateTopicError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteEndpointError> for Error

Source§

fn from(err: DeleteEndpointError) -> Self

Converts to this type from the input type.
Source§

impl From<DeletePlatformApplicationError> for Error

Source§

fn from(err: DeletePlatformApplicationError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteSMSSandboxPhoneNumberError> for Error

Source§

fn from(err: DeleteSMSSandboxPhoneNumberError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteTopicError> for Error

Source§

fn from(err: DeleteTopicError) -> Self

Converts to this type from the input type.
Source§

impl From<GetDataProtectionPolicyError> for Error

Source§

fn from(err: GetDataProtectionPolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<GetEndpointAttributesError> for Error

Source§

fn from(err: GetEndpointAttributesError) -> Self

Converts to this type from the input type.
Source§

impl From<GetPlatformApplicationAttributesError> for Error

Source§

fn from(err: GetPlatformApplicationAttributesError) -> Self

Converts to this type from the input type.
Source§

impl From<GetSMSAttributesError> for Error

Source§

fn from(err: GetSMSAttributesError) -> Self

Converts to this type from the input type.
Source§

impl From<GetSMSSandboxAccountStatusError> for Error

Source§

fn from(err: GetSMSSandboxAccountStatusError) -> Self

Converts to this type from the input type.
Source§

impl From<GetSubscriptionAttributesError> for Error

Source§

fn from(err: GetSubscriptionAttributesError) -> Self

Converts to this type from the input type.
Source§

impl From<GetTopicAttributesError> for Error

Source§

fn from(err: GetTopicAttributesError) -> Self

Converts to this type from the input type.
Source§

impl From<ListEndpointsByPlatformApplicationError> for Error

Source§

fn from(err: ListEndpointsByPlatformApplicationError) -> Self

Converts to this type from the input type.
Source§

impl From<ListOriginationNumbersError> for Error

Source§

fn from(err: ListOriginationNumbersError) -> Self

Converts to this type from the input type.
Source§

impl From<ListPhoneNumbersOptedOutError> for Error

Source§

fn from(err: ListPhoneNumbersOptedOutError) -> Self

Converts to this type from the input type.
Source§

impl From<ListPlatformApplicationsError> for Error

Source§

fn from(err: ListPlatformApplicationsError) -> Self

Converts to this type from the input type.
Source§

impl From<ListSMSSandboxPhoneNumbersError> for Error

Source§

fn from(err: ListSMSSandboxPhoneNumbersError) -> Self

Converts to this type from the input type.
Source§

impl From<ListSubscriptionsByTopicError> for Error

Source§

fn from(err: ListSubscriptionsByTopicError) -> Self

Converts to this type from the input type.
Source§

impl From<ListSubscriptionsError> for Error

Source§

fn from(err: ListSubscriptionsError) -> Self

Converts to this type from the input type.
Source§

impl From<ListTagsForResourceError> for Error

Source§

fn from(err: ListTagsForResourceError) -> Self

Converts to this type from the input type.
Source§

impl From<ListTopicsError> for Error

Source§

fn from(err: ListTopicsError) -> Self

Converts to this type from the input type.
Source§

impl From<OptInPhoneNumberError> for Error

Source§

fn from(err: OptInPhoneNumberError) -> Self

Converts to this type from the input type.
Source§

impl From<PublishBatchError> for Error

Source§

fn from(err: PublishBatchError) -> Self

Converts to this type from the input type.
Source§

impl From<PublishError> for Error

Source§

fn from(err: PublishError) -> Self

Converts to this type from the input type.
Source§

impl From<PutDataProtectionPolicyError> for Error

Source§

fn from(err: PutDataProtectionPolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<RemovePermissionError> for Error

Source§

fn from(err: RemovePermissionError) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<AddPermissionError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<AddPermissionError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<CheckIfPhoneNumberIsOptedOutError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<CheckIfPhoneNumberIsOptedOutError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<ConfirmSubscriptionError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<ConfirmSubscriptionError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<CreatePlatformApplicationError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<CreatePlatformApplicationError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<CreatePlatformEndpointError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<CreatePlatformEndpointError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<CreateSMSSandboxPhoneNumberError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<CreateSMSSandboxPhoneNumberError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<CreateTopicError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<CreateTopicError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<DeleteEndpointError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<DeleteEndpointError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<DeletePlatformApplicationError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<DeletePlatformApplicationError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<DeleteSMSSandboxPhoneNumberError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<DeleteSMSSandboxPhoneNumberError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<DeleteTopicError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<DeleteTopicError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<GetDataProtectionPolicyError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<GetDataProtectionPolicyError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<GetEndpointAttributesError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<GetEndpointAttributesError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<GetPlatformApplicationAttributesError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<GetPlatformApplicationAttributesError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<GetSMSAttributesError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<GetSMSAttributesError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<GetSMSSandboxAccountStatusError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<GetSMSSandboxAccountStatusError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<GetSubscriptionAttributesError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<GetSubscriptionAttributesError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<GetTopicAttributesError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<GetTopicAttributesError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<ListEndpointsByPlatformApplicationError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<ListEndpointsByPlatformApplicationError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<ListOriginationNumbersError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<ListOriginationNumbersError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<ListPhoneNumbersOptedOutError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<ListPhoneNumbersOptedOutError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<ListPlatformApplicationsError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<ListPlatformApplicationsError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<ListSMSSandboxPhoneNumbersError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<ListSMSSandboxPhoneNumbersError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<ListSubscriptionsByTopicError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<ListSubscriptionsByTopicError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<ListSubscriptionsError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<ListSubscriptionsError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<ListTagsForResourceError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<ListTagsForResourceError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<ListTopicsError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<ListTopicsError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<OptInPhoneNumberError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<OptInPhoneNumberError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<PublishBatchError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<PublishBatchError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<PublishError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<PublishError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<PutDataProtectionPolicyError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<PutDataProtectionPolicyError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<RemovePermissionError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<RemovePermissionError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<SetEndpointAttributesError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<SetEndpointAttributesError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<SetPlatformApplicationAttributesError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<SetPlatformApplicationAttributesError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<SetSMSAttributesError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<SetSMSAttributesError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<SetSubscriptionAttributesError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<SetSubscriptionAttributesError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<SetTopicAttributesError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<SetTopicAttributesError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<SubscribeError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<SubscribeError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<TagResourceError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<TagResourceError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<UnsubscribeError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<UnsubscribeError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<UntagResourceError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<UntagResourceError, R>) -> Self

Converts to this type from the input type.
Source§

impl<R> From<SdkError<VerifySMSSandboxPhoneNumberError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

fn from(err: SdkError<VerifySMSSandboxPhoneNumberError, R>) -> Self

Converts to this type from the input type.
Source§

impl From<SetEndpointAttributesError> for Error

Source§

fn from(err: SetEndpointAttributesError) -> Self

Converts to this type from the input type.
Source§

impl From<SetPlatformApplicationAttributesError> for Error

Source§

fn from(err: SetPlatformApplicationAttributesError) -> Self

Converts to this type from the input type.
Source§

impl From<SetSMSAttributesError> for Error

Source§

fn from(err: SetSMSAttributesError) -> Self

Converts to this type from the input type.
Source§

impl From<SetSubscriptionAttributesError> for Error

Source§

fn from(err: SetSubscriptionAttributesError) -> Self

Converts to this type from the input type.
Source§

impl From<SetTopicAttributesError> for Error

Source§

fn from(err: SetTopicAttributesError) -> Self

Converts to this type from the input type.
Source§

impl From<SubscribeError> for Error

Source§

fn from(err: SubscribeError) -> Self

Converts to this type from the input type.
Source§

impl From<TagResourceError> for Error

Source§

fn from(err: TagResourceError) -> Self

Converts to this type from the input type.
Source§

impl From<UnsubscribeError> for Error

Source§

fn from(err: UnsubscribeError) -> Self

Converts to this type from the input type.
Source§

impl From<UntagResourceError> for Error

Source§

fn from(err: UntagResourceError) -> Self

Converts to this type from the input type.
Source§

impl From<VerifySMSSandboxPhoneNumberError> for Error

Source§

fn from(err: VerifySMSSandboxPhoneNumberError) -> Self

Converts to this type from the input type.
Source§

impl ProvideErrorMetadata for Error

Source§

fn meta(&self) -> &ErrorMetadata

Returns error metadata, which includes the error code, message, request ID, and potentially additional information.
Source§

fn code(&self) -> Option<&str>

Returns the error code if it’s available.
Source§

fn message(&self) -> Option<&str>

Returns the error message, if there is one.
Source§

impl RequestId for Error

Source§

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

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>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

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>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

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>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

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>

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

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>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

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>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

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>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

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>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,