#[non_exhaustive]pub enum Error {
Show 33 variants
AccessPointAlreadyExists(AccessPointAlreadyExists),
AccessPointLimitExceeded(AccessPointLimitExceeded),
AccessPointNotFound(AccessPointNotFound),
AvailabilityZonesMismatch(AvailabilityZonesMismatch),
BadRequest(BadRequest),
ConflictException(ConflictException),
DependencyTimeout(DependencyTimeout),
FileSystemAlreadyExists(FileSystemAlreadyExists),
FileSystemInUse(FileSystemInUse),
FileSystemLimitExceeded(FileSystemLimitExceeded),
FileSystemNotFound(FileSystemNotFound),
IncorrectFileSystemLifeCycleState(IncorrectFileSystemLifeCycleState),
IncorrectMountTargetState(IncorrectMountTargetState),
InsufficientThroughputCapacity(InsufficientThroughputCapacity),
InternalServerError(InternalServerError),
InvalidPolicyException(InvalidPolicyException),
IpAddressInUse(IpAddressInUse),
MountTargetConflict(MountTargetConflict),
MountTargetNotFound(MountTargetNotFound),
NetworkInterfaceLimitExceeded(NetworkInterfaceLimitExceeded),
NoFreeAddressesInSubnet(NoFreeAddressesInSubnet),
PolicyNotFound(PolicyNotFound),
ReplicationAlreadyExists(ReplicationAlreadyExists),
ReplicationNotFound(ReplicationNotFound),
SecurityGroupLimitExceeded(SecurityGroupLimitExceeded),
SecurityGroupNotFound(SecurityGroupNotFound),
SubnetNotFound(SubnetNotFound),
ThrottlingException(ThrottlingException),
ThroughputLimitExceeded(ThroughputLimitExceeded),
TooManyRequests(TooManyRequests),
UnsupportedAvailabilityZone(UnsupportedAvailabilityZone),
ValidationException(ValidationException),
Unhandled(Unhandled),
}
Expand description
All possible error types for this service.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
AccessPointAlreadyExists(AccessPointAlreadyExists)
Returned if the access point that you are trying to create already exists, with the creation token you provided in the request.
AccessPointLimitExceeded(AccessPointLimitExceeded)
Returned if the Amazon Web Services account has already created the maximum number of access points allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region.
AccessPointNotFound(AccessPointNotFound)
Returned if the specified AccessPointId
value doesn't exist in the requester's Amazon Web Services account.
AvailabilityZonesMismatch(AvailabilityZonesMismatch)
Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone storage redundancy.
BadRequest(BadRequest)
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
ConflictException(ConflictException)
Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.
DependencyTimeout(DependencyTimeout)
The service timed out trying to fulfill the request, and the client should try the call again.
FileSystemAlreadyExists(FileSystemAlreadyExists)
Returned if the file system you are trying to create already exists, with the creation token you provided.
FileSystemInUse(FileSystemInUse)
Returned if a file system has mount targets.
FileSystemLimitExceeded(FileSystemLimitExceeded)
Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.
FileSystemNotFound(FileSystemNotFound)
Returned if the specified FileSystemId
value doesn't exist in the requester's Amazon Web Services account.
IncorrectFileSystemLifeCycleState(IncorrectFileSystemLifeCycleState)
Returned if the file system's lifecycle state is not "available".
IncorrectMountTargetState(IncorrectMountTargetState)
Returned if the mount target is not in the correct state for the operation.
InsufficientThroughputCapacity(InsufficientThroughputCapacity)
Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
InternalServerError(InternalServerError)
Returned if an error occurred on the server side.
InvalidPolicyException(InvalidPolicyException)
Returned if the FileSystemPolicy
is malformed or contains an error such as a parameter value that is not valid or a missing required parameter. Returned in the case of a policy lockout safety check error.
IpAddressInUse(IpAddressInUse)
Returned if the request specified an IpAddress
that is already in use in the subnet.
MountTargetConflict(MountTargetConflict)
Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.
MountTargetNotFound(MountTargetNotFound)
Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
NetworkInterfaceLimitExceeded(NetworkInterfaceLimitExceeded)
The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. Either delete some network interfaces or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Network interfaces per Region entry in the Network interfaces table).
NoFreeAddressesInSubnet(NoFreeAddressesInSubnet)
Returned if IpAddress
was not specified in the request and there are no free IP addresses in the subnet.
PolicyNotFound(PolicyNotFound)
Returned if the default file system policy is in effect for the EFS file system specified.
ReplicationAlreadyExists(ReplicationAlreadyExists)
Returned if the file system is already included in a replication configuration.>
ReplicationNotFound(ReplicationNotFound)
Returned if the specified file system does not have a replication configuration.
SecurityGroupLimitExceeded(SecurityGroupLimitExceeded)
Returned if the size of SecurityGroups
specified in the request is greater than five.
SecurityGroupNotFound(SecurityGroupNotFound)
Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).
SubnetNotFound(SubnetNotFound)
Returned if there is no subnet with ID SubnetId
provided in the request.
ThrottlingException(ThrottlingException)
Returned when the CreateAccessPoint
API action is called too quickly and the number of Access Points on the file system is nearing the limit of 120.
ThroughputLimitExceeded(ThroughputLimitExceeded)
Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
TooManyRequests(TooManyRequests)
Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.
UnsupportedAvailabilityZone(UnsupportedAvailabilityZone)
Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
ValidationException(ValidationException)
Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
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<CreateAccessPointError> for Error
impl From<CreateAccessPointError> for Error
Source§fn from(err: CreateAccessPointError) -> Self
fn from(err: CreateAccessPointError) -> Self
Source§impl From<CreateFileSystemError> for Error
impl From<CreateFileSystemError> for Error
Source§fn from(err: CreateFileSystemError) -> Self
fn from(err: CreateFileSystemError) -> Self
Source§impl From<CreateMountTargetError> for Error
impl From<CreateMountTargetError> for Error
Source§fn from(err: CreateMountTargetError) -> Self
fn from(err: CreateMountTargetError) -> Self
Source§impl From<CreateReplicationConfigurationError> for Error
impl From<CreateReplicationConfigurationError> for Error
Source§fn from(err: CreateReplicationConfigurationError) -> Self
fn from(err: CreateReplicationConfigurationError) -> Self
Source§impl From<CreateTagsError> for Error
impl From<CreateTagsError> for Error
Source§fn from(err: CreateTagsError) -> Self
fn from(err: CreateTagsError) -> Self
Source§impl From<DeleteAccessPointError> for Error
impl From<DeleteAccessPointError> for Error
Source§fn from(err: DeleteAccessPointError) -> Self
fn from(err: DeleteAccessPointError) -> Self
Source§impl From<DeleteFileSystemError> for Error
impl From<DeleteFileSystemError> for Error
Source§fn from(err: DeleteFileSystemError) -> Self
fn from(err: DeleteFileSystemError) -> Self
Source§impl From<DeleteFileSystemPolicyError> for Error
impl From<DeleteFileSystemPolicyError> for Error
Source§fn from(err: DeleteFileSystemPolicyError) -> Self
fn from(err: DeleteFileSystemPolicyError) -> Self
Source§impl From<DeleteMountTargetError> for Error
impl From<DeleteMountTargetError> for Error
Source§fn from(err: DeleteMountTargetError) -> Self
fn from(err: DeleteMountTargetError) -> Self
Source§impl From<DeleteReplicationConfigurationError> for Error
impl From<DeleteReplicationConfigurationError> for Error
Source§fn from(err: DeleteReplicationConfigurationError) -> Self
fn from(err: DeleteReplicationConfigurationError) -> Self
Source§impl From<DeleteTagsError> for Error
impl From<DeleteTagsError> for Error
Source§fn from(err: DeleteTagsError) -> Self
fn from(err: DeleteTagsError) -> Self
Source§impl From<DescribeAccessPointsError> for Error
impl From<DescribeAccessPointsError> for Error
Source§fn from(err: DescribeAccessPointsError) -> Self
fn from(err: DescribeAccessPointsError) -> Self
Source§impl From<DescribeAccountPreferencesError> for Error
impl From<DescribeAccountPreferencesError> for Error
Source§fn from(err: DescribeAccountPreferencesError) -> Self
fn from(err: DescribeAccountPreferencesError) -> Self
Source§impl From<DescribeBackupPolicyError> for Error
impl From<DescribeBackupPolicyError> for Error
Source§fn from(err: DescribeBackupPolicyError) -> Self
fn from(err: DescribeBackupPolicyError) -> Self
Source§impl From<DescribeFileSystemPolicyError> for Error
impl From<DescribeFileSystemPolicyError> for Error
Source§fn from(err: DescribeFileSystemPolicyError) -> Self
fn from(err: DescribeFileSystemPolicyError) -> Self
Source§impl From<DescribeFileSystemsError> for Error
impl From<DescribeFileSystemsError> for Error
Source§fn from(err: DescribeFileSystemsError) -> Self
fn from(err: DescribeFileSystemsError) -> Self
Source§impl From<DescribeLifecycleConfigurationError> for Error
impl From<DescribeLifecycleConfigurationError> for Error
Source§fn from(err: DescribeLifecycleConfigurationError) -> Self
fn from(err: DescribeLifecycleConfigurationError) -> Self
Source§impl From<DescribeMountTargetSecurityGroupsError> for Error
impl From<DescribeMountTargetSecurityGroupsError> for Error
Source§fn from(err: DescribeMountTargetSecurityGroupsError) -> Self
fn from(err: DescribeMountTargetSecurityGroupsError) -> Self
Source§impl From<DescribeMountTargetsError> for Error
impl From<DescribeMountTargetsError> for Error
Source§fn from(err: DescribeMountTargetsError) -> Self
fn from(err: DescribeMountTargetsError) -> Self
Source§impl From<DescribeReplicationConfigurationsError> for Error
impl From<DescribeReplicationConfigurationsError> for Error
Source§fn from(err: DescribeReplicationConfigurationsError) -> Self
fn from(err: DescribeReplicationConfigurationsError) -> Self
Source§impl From<DescribeTagsError> for Error
impl From<DescribeTagsError> for Error
Source§fn from(err: DescribeTagsError) -> Self
fn from(err: DescribeTagsError) -> Self
Source§impl From<ListTagsForResourceError> for Error
impl From<ListTagsForResourceError> for Error
Source§fn from(err: ListTagsForResourceError) -> Self
fn from(err: ListTagsForResourceError) -> Self
Source§impl From<ModifyMountTargetSecurityGroupsError> for Error
impl From<ModifyMountTargetSecurityGroupsError> for Error
Source§fn from(err: ModifyMountTargetSecurityGroupsError) -> Self
fn from(err: ModifyMountTargetSecurityGroupsError) -> Self
Source§impl From<PutAccountPreferencesError> for Error
impl From<PutAccountPreferencesError> for Error
Source§fn from(err: PutAccountPreferencesError) -> Self
fn from(err: PutAccountPreferencesError) -> Self
Source§impl From<PutBackupPolicyError> for Error
impl From<PutBackupPolicyError> for Error
Source§fn from(err: PutBackupPolicyError) -> Self
fn from(err: PutBackupPolicyError) -> Self
Source§impl From<PutFileSystemPolicyError> for Error
impl From<PutFileSystemPolicyError> for Error
Source§fn from(err: PutFileSystemPolicyError) -> Self
fn from(err: PutFileSystemPolicyError) -> Self
Source§impl From<PutLifecycleConfigurationError> for Error
impl From<PutLifecycleConfigurationError> for Error
Source§fn from(err: PutLifecycleConfigurationError) -> Self
fn from(err: PutLifecycleConfigurationError) -> Self
Source§impl<R> From<SdkError<CreateAccessPointError, R>> for Error
impl<R> From<SdkError<CreateAccessPointError, R>> for Error
Source§fn from(err: SdkError<CreateAccessPointError, R>) -> Self
fn from(err: SdkError<CreateAccessPointError, R>) -> Self
Source§impl<R> From<SdkError<CreateFileSystemError, R>> for Error
impl<R> From<SdkError<CreateFileSystemError, R>> for Error
Source§fn from(err: SdkError<CreateFileSystemError, R>) -> Self
fn from(err: SdkError<CreateFileSystemError, R>) -> Self
Source§impl<R> From<SdkError<CreateMountTargetError, R>> for Error
impl<R> From<SdkError<CreateMountTargetError, R>> for Error
Source§fn from(err: SdkError<CreateMountTargetError, R>) -> Self
fn from(err: SdkError<CreateMountTargetError, R>) -> Self
Source§impl<R> From<SdkError<CreateReplicationConfigurationError, R>> for Error
impl<R> From<SdkError<CreateReplicationConfigurationError, R>> for Error
Source§fn from(err: SdkError<CreateReplicationConfigurationError, R>) -> Self
fn from(err: SdkError<CreateReplicationConfigurationError, R>) -> Self
Source§impl<R> From<SdkError<CreateTagsError, R>> for Error
impl<R> From<SdkError<CreateTagsError, R>> for Error
Source§fn from(err: SdkError<CreateTagsError, R>) -> Self
fn from(err: SdkError<CreateTagsError, R>) -> Self
Source§impl<R> From<SdkError<DeleteAccessPointError, R>> for Error
impl<R> From<SdkError<DeleteAccessPointError, R>> for Error
Source§fn from(err: SdkError<DeleteAccessPointError, R>) -> Self
fn from(err: SdkError<DeleteAccessPointError, R>) -> Self
Source§impl<R> From<SdkError<DeleteFileSystemError, R>> for Error
impl<R> From<SdkError<DeleteFileSystemError, R>> for Error
Source§fn from(err: SdkError<DeleteFileSystemError, R>) -> Self
fn from(err: SdkError<DeleteFileSystemError, R>) -> Self
Source§impl<R> From<SdkError<DeleteFileSystemPolicyError, R>> for Error
impl<R> From<SdkError<DeleteFileSystemPolicyError, R>> for Error
Source§fn from(err: SdkError<DeleteFileSystemPolicyError, R>) -> Self
fn from(err: SdkError<DeleteFileSystemPolicyError, R>) -> Self
Source§impl<R> From<SdkError<DeleteMountTargetError, R>> for Error
impl<R> From<SdkError<DeleteMountTargetError, R>> for Error
Source§fn from(err: SdkError<DeleteMountTargetError, R>) -> Self
fn from(err: SdkError<DeleteMountTargetError, R>) -> Self
Source§impl<R> From<SdkError<DeleteReplicationConfigurationError, R>> for Error
impl<R> From<SdkError<DeleteReplicationConfigurationError, R>> for Error
Source§fn from(err: SdkError<DeleteReplicationConfigurationError, R>) -> Self
fn from(err: SdkError<DeleteReplicationConfigurationError, R>) -> Self
Source§impl<R> From<SdkError<DeleteTagsError, R>> for Error
impl<R> From<SdkError<DeleteTagsError, R>> for Error
Source§fn from(err: SdkError<DeleteTagsError, R>) -> Self
fn from(err: SdkError<DeleteTagsError, R>) -> Self
Source§impl<R> From<SdkError<DescribeAccessPointsError, R>> for Error
impl<R> From<SdkError<DescribeAccessPointsError, R>> for Error
Source§fn from(err: SdkError<DescribeAccessPointsError, R>) -> Self
fn from(err: SdkError<DescribeAccessPointsError, R>) -> Self
Source§impl<R> From<SdkError<DescribeAccountPreferencesError, R>> for Error
impl<R> From<SdkError<DescribeAccountPreferencesError, R>> for Error
Source§fn from(err: SdkError<DescribeAccountPreferencesError, R>) -> Self
fn from(err: SdkError<DescribeAccountPreferencesError, R>) -> Self
Source§impl<R> From<SdkError<DescribeBackupPolicyError, R>> for Error
impl<R> From<SdkError<DescribeBackupPolicyError, R>> for Error
Source§fn from(err: SdkError<DescribeBackupPolicyError, R>) -> Self
fn from(err: SdkError<DescribeBackupPolicyError, R>) -> Self
Source§impl<R> From<SdkError<DescribeFileSystemPolicyError, R>> for Error
impl<R> From<SdkError<DescribeFileSystemPolicyError, R>> for Error
Source§fn from(err: SdkError<DescribeFileSystemPolicyError, R>) -> Self
fn from(err: SdkError<DescribeFileSystemPolicyError, R>) -> Self
Source§impl<R> From<SdkError<DescribeFileSystemsError, R>> for Error
impl<R> From<SdkError<DescribeFileSystemsError, R>> for Error
Source§fn from(err: SdkError<DescribeFileSystemsError, R>) -> Self
fn from(err: SdkError<DescribeFileSystemsError, R>) -> Self
Source§impl<R> From<SdkError<DescribeLifecycleConfigurationError, R>> for Error
impl<R> From<SdkError<DescribeLifecycleConfigurationError, R>> for Error
Source§fn from(err: SdkError<DescribeLifecycleConfigurationError, R>) -> Self
fn from(err: SdkError<DescribeLifecycleConfigurationError, R>) -> Self
Source§impl<R> From<SdkError<DescribeMountTargetSecurityGroupsError, R>> for Error
impl<R> From<SdkError<DescribeMountTargetSecurityGroupsError, R>> for Error
Source§fn from(err: SdkError<DescribeMountTargetSecurityGroupsError, R>) -> Self
fn from(err: SdkError<DescribeMountTargetSecurityGroupsError, R>) -> Self
Source§impl<R> From<SdkError<DescribeMountTargetsError, R>> for Error
impl<R> From<SdkError<DescribeMountTargetsError, R>> for Error
Source§fn from(err: SdkError<DescribeMountTargetsError, R>) -> Self
fn from(err: SdkError<DescribeMountTargetsError, R>) -> Self
Source§impl<R> From<SdkError<DescribeReplicationConfigurationsError, R>> for Error
impl<R> From<SdkError<DescribeReplicationConfigurationsError, R>> for Error
Source§fn from(err: SdkError<DescribeReplicationConfigurationsError, R>) -> Self
fn from(err: SdkError<DescribeReplicationConfigurationsError, R>) -> Self
Source§impl<R> From<SdkError<DescribeTagsError, R>> for Error
impl<R> From<SdkError<DescribeTagsError, R>> for Error
Source§fn from(err: SdkError<DescribeTagsError, R>) -> Self
fn from(err: SdkError<DescribeTagsError, R>) -> Self
Source§impl<R> From<SdkError<ListTagsForResourceError, R>> for Error
impl<R> From<SdkError<ListTagsForResourceError, R>> for Error
Source§fn from(err: SdkError<ListTagsForResourceError, R>) -> Self
fn from(err: SdkError<ListTagsForResourceError, R>) -> Self
Source§impl<R> From<SdkError<ModifyMountTargetSecurityGroupsError, R>> for Error
impl<R> From<SdkError<ModifyMountTargetSecurityGroupsError, R>> for Error
Source§fn from(err: SdkError<ModifyMountTargetSecurityGroupsError, R>) -> Self
fn from(err: SdkError<ModifyMountTargetSecurityGroupsError, R>) -> Self
Source§impl<R> From<SdkError<PutAccountPreferencesError, R>> for Error
impl<R> From<SdkError<PutAccountPreferencesError, R>> for Error
Source§fn from(err: SdkError<PutAccountPreferencesError, R>) -> Self
fn from(err: SdkError<PutAccountPreferencesError, R>) -> Self
Source§impl<R> From<SdkError<PutBackupPolicyError, R>> for Error
impl<R> From<SdkError<PutBackupPolicyError, R>> for Error
Source§fn from(err: SdkError<PutBackupPolicyError, R>) -> Self
fn from(err: SdkError<PutBackupPolicyError, R>) -> Self
Source§impl<R> From<SdkError<PutFileSystemPolicyError, R>> for Error
impl<R> From<SdkError<PutFileSystemPolicyError, R>> for Error
Source§fn from(err: SdkError<PutFileSystemPolicyError, R>) -> Self
fn from(err: SdkError<PutFileSystemPolicyError, R>) -> Self
Source§impl<R> From<SdkError<PutLifecycleConfigurationError, R>> for Error
impl<R> From<SdkError<PutLifecycleConfigurationError, R>> for Error
Source§fn from(err: SdkError<PutLifecycleConfigurationError, R>) -> Self
fn from(err: SdkError<PutLifecycleConfigurationError, 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<UpdateFileSystemError, R>> for Error
impl<R> From<SdkError<UpdateFileSystemError, R>> for Error
Source§fn from(err: SdkError<UpdateFileSystemError, R>) -> Self
fn from(err: SdkError<UpdateFileSystemError, R>) -> Self
Source§impl<R> From<SdkError<UpdateFileSystemProtectionError, R>> for Error
impl<R> From<SdkError<UpdateFileSystemProtectionError, R>> for Error
Source§fn from(err: SdkError<UpdateFileSystemProtectionError, R>) -> Self
fn from(err: SdkError<UpdateFileSystemProtectionError, 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<UpdateFileSystemError> for Error
impl From<UpdateFileSystemError> for Error
Source§fn from(err: UpdateFileSystemError) -> Self
fn from(err: UpdateFileSystemError) -> Self
Source§impl From<UpdateFileSystemProtectionError> for Error
impl From<UpdateFileSystemProtectionError> for Error
Source§fn from(err: UpdateFileSystemProtectionError) -> Self
fn from(err: UpdateFileSystemProtectionError) -> 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>
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);