Enum Error

Source
#[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
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.
§

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)

👎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<BuildError> for Error

Source§

fn from(value: BuildError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateAccessPointError> for Error

Source§

fn from(err: CreateAccessPointError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateFileSystemError> for Error

Source§

fn from(err: CreateFileSystemError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateMountTargetError> for Error

Source§

fn from(err: CreateMountTargetError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateReplicationConfigurationError> for Error

Source§

fn from(err: CreateReplicationConfigurationError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateTagsError> for Error

Source§

fn from(err: CreateTagsError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteAccessPointError> for Error

Source§

fn from(err: DeleteAccessPointError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteFileSystemError> for Error

Source§

fn from(err: DeleteFileSystemError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteFileSystemPolicyError> for Error

Source§

fn from(err: DeleteFileSystemPolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteMountTargetError> for Error

Source§

fn from(err: DeleteMountTargetError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteReplicationConfigurationError> for Error

Source§

fn from(err: DeleteReplicationConfigurationError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteTagsError> for Error

Source§

fn from(err: DeleteTagsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeAccessPointsError> for Error

Source§

fn from(err: DescribeAccessPointsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeAccountPreferencesError> for Error

Source§

fn from(err: DescribeAccountPreferencesError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeBackupPolicyError> for Error

Source§

fn from(err: DescribeBackupPolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeFileSystemPolicyError> for Error

Source§

fn from(err: DescribeFileSystemPolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeFileSystemsError> for Error

Source§

fn from(err: DescribeFileSystemsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeLifecycleConfigurationError> for Error

Source§

fn from(err: DescribeLifecycleConfigurationError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeMountTargetSecurityGroupsError> for Error

Source§

fn from(err: DescribeMountTargetSecurityGroupsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeMountTargetsError> for Error

Source§

fn from(err: DescribeMountTargetsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeReplicationConfigurationsError> for Error

Source§

fn from(err: DescribeReplicationConfigurationsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeTagsError> for Error

Source§

fn from(err: DescribeTagsError) -> 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<ModifyMountTargetSecurityGroupsError> for Error

Source§

fn from(err: ModifyMountTargetSecurityGroupsError) -> Self

Converts to this type from the input type.
Source§

impl From<PutAccountPreferencesError> for Error

Source§

fn from(err: PutAccountPreferencesError) -> Self

Converts to this type from the input type.
Source§

impl From<PutBackupPolicyError> for Error

Source§

fn from(err: PutBackupPolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<PutFileSystemPolicyError> for Error

Source§

fn from(err: PutFileSystemPolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<PutLifecycleConfigurationError> for Error

Source§

fn from(err: PutLifecycleConfigurationError) -> Self

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

fn from(err: SdkError<DescribeTagsError, 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<ModifyMountTargetSecurityGroupsError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

fn from(err: SdkError<PutLifecycleConfigurationError, 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<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<UpdateFileSystemError, R>> for Error
where R: Send + Sync + Debug + 'static,

Source§

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

Converts to this type from the input type.
Source§

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

Source§

fn from(err: SdkError<UpdateFileSystemProtectionError, R>) -> 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<UntagResourceError> for Error

Source§

fn from(err: UntagResourceError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateFileSystemError> for Error

Source§

fn from(err: UpdateFileSystemError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateFileSystemProtectionError> for Error

Source§

fn from(err: UpdateFileSystemProtectionError) -> 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,