aws_sdk_workdocs

Enum Error

Source
#[non_exhaustive]
pub enum Error {
Show 26 variants ConcurrentModificationException(ConcurrentModificationException), ConflictingOperationException(ConflictingOperationException), CustomMetadataLimitExceededException(CustomMetadataLimitExceededException), DeactivatingLastSystemUserException(DeactivatingLastSystemUserException), DocumentLockedForCommentsException(DocumentLockedForCommentsException), DraftUploadOutOfSyncException(DraftUploadOutOfSyncException), EntityAlreadyExistsException(EntityAlreadyExistsException), EntityNotExistsException(EntityNotExistsException), FailedDependencyException(FailedDependencyException), IllegalUserStateException(IllegalUserStateException), InvalidArgumentException(InvalidArgumentException), InvalidCommentOperationException(InvalidCommentOperationException), InvalidOperationException(InvalidOperationException), InvalidPasswordException(InvalidPasswordException), LimitExceededException(LimitExceededException), ProhibitedStateException(ProhibitedStateException), RequestedEntityTooLargeException(RequestedEntityTooLargeException), ResourceAlreadyCheckedOutException(ResourceAlreadyCheckedOutException), ServiceUnavailableException(ServiceUnavailableException), StorageLimitExceededException(StorageLimitExceededException), StorageLimitWillExceedException(StorageLimitWillExceedException), TooManyLabelsException(TooManyLabelsException), TooManySubscriptionsException(TooManySubscriptionsException), UnauthorizedOperationException(UnauthorizedOperationException), UnauthorizedResourceAccessException(UnauthorizedResourceAccessException), 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.
§

ConcurrentModificationException(ConcurrentModificationException)

The resource hierarchy is changing.

§

ConflictingOperationException(ConflictingOperationException)

Another operation is in progress on the resource that conflicts with the current operation.

§

CustomMetadataLimitExceededException(CustomMetadataLimitExceededException)

The limit has been reached on the number of custom properties for the specified resource.

§

DeactivatingLastSystemUserException(DeactivatingLastSystemUserException)

The last user in the organization is being deactivated.

§

DocumentLockedForCommentsException(DocumentLockedForCommentsException)

This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.

§

DraftUploadOutOfSyncException(DraftUploadOutOfSyncException)

This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.

§

EntityAlreadyExistsException(EntityAlreadyExistsException)

The resource already exists.

§

EntityNotExistsException(EntityNotExistsException)

The resource does not exist.

§

FailedDependencyException(FailedDependencyException)

The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

§

IllegalUserStateException(IllegalUserStateException)

The user is undergoing transfer of ownership.

§

InvalidArgumentException(InvalidArgumentException)

The pagination marker or limit fields are not valid.

§

InvalidCommentOperationException(InvalidCommentOperationException)

The requested operation is not allowed on the specified comment object.

§

InvalidOperationException(InvalidOperationException)

The operation is invalid.

§

InvalidPasswordException(InvalidPasswordException)

The password is invalid.

§

LimitExceededException(LimitExceededException)

The maximum of 100,000 files and folders under the parent folder has been exceeded.

§

ProhibitedStateException(ProhibitedStateException)

The specified document version is not in the INITIALIZED state.

§

RequestedEntityTooLargeException(RequestedEntityTooLargeException)

The response is too large to return. The request must include a filter to reduce the size of the response.

§

ResourceAlreadyCheckedOutException(ResourceAlreadyCheckedOutException)

The resource is already checked out.

§

ServiceUnavailableException(ServiceUnavailableException)

One or more of the dependencies is unavailable.

§

StorageLimitExceededException(StorageLimitExceededException)

The storage limit has been exceeded.

§

StorageLimitWillExceedException(StorageLimitWillExceedException)

The storage limit will be exceeded.

§

TooManyLabelsException(TooManyLabelsException)

The limit has been reached on the number of labels for the specified resource.

§

TooManySubscriptionsException(TooManySubscriptionsException)

You've reached the limit on the number of subscriptions for the WorkDocs instance.

§

UnauthorizedOperationException(UnauthorizedOperationException)

The operation is not permitted.

§

UnauthorizedResourceAccessException(UnauthorizedResourceAccessException)

The caller does not have access to perform the action on the resource.

§

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<AbortDocumentVersionUploadError> for Error

Source§

fn from(err: AbortDocumentVersionUploadError) -> Self

Converts to this type from the input type.
Source§

impl From<ActivateUserError> for Error

Source§

fn from(err: ActivateUserError) -> Self

Converts to this type from the input type.
Source§

impl From<AddResourcePermissionsError> for Error

Source§

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

Source§

fn from(err: CreateCommentError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateCustomMetadataError> for Error

Source§

fn from(err: CreateCustomMetadataError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateFolderError> for Error

Source§

fn from(err: CreateFolderError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateLabelsError> for Error

Source§

fn from(err: CreateLabelsError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateNotificationSubscriptionError> for Error

Source§

fn from(err: CreateNotificationSubscriptionError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateUserError> for Error

Source§

fn from(err: CreateUserError) -> Self

Converts to this type from the input type.
Source§

impl From<DeactivateUserError> for Error

Source§

fn from(err: DeactivateUserError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteCommentError> for Error

Source§

fn from(err: DeleteCommentError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteCustomMetadataError> for Error

Source§

fn from(err: DeleteCustomMetadataError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteDocumentError> for Error

Source§

fn from(err: DeleteDocumentError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteDocumentVersionError> for Error

Source§

fn from(err: DeleteDocumentVersionError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteFolderContentsError> for Error

Source§

fn from(err: DeleteFolderContentsError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteFolderError> for Error

Source§

fn from(err: DeleteFolderError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteLabelsError> for Error

Source§

fn from(err: DeleteLabelsError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteNotificationSubscriptionError> for Error

Source§

fn from(err: DeleteNotificationSubscriptionError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteUserError> for Error

Source§

fn from(err: DeleteUserError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeActivitiesError> for Error

Source§

fn from(err: DescribeActivitiesError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeCommentsError> for Error

Source§

fn from(err: DescribeCommentsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeDocumentVersionsError> for Error

Source§

fn from(err: DescribeDocumentVersionsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeFolderContentsError> for Error

Source§

fn from(err: DescribeFolderContentsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeGroupsError> for Error

Source§

fn from(err: DescribeGroupsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeNotificationSubscriptionsError> for Error

Source§

fn from(err: DescribeNotificationSubscriptionsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeResourcePermissionsError> for Error

Source§

fn from(err: DescribeResourcePermissionsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeRootFoldersError> for Error

Source§

fn from(err: DescribeRootFoldersError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeUsersError> for Error

Source§

fn from(err: DescribeUsersError) -> Self

Converts to this type from the input type.
Source§

impl From<GetCurrentUserError> for Error

Source§

fn from(err: GetCurrentUserError) -> Self

Converts to this type from the input type.
Source§

impl From<GetDocumentError> for Error

Source§

fn from(err: GetDocumentError) -> Self

Converts to this type from the input type.
Source§

impl From<GetDocumentPathError> for Error

Source§

fn from(err: GetDocumentPathError) -> Self

Converts to this type from the input type.
Source§

impl From<GetDocumentVersionError> for Error

Source§

fn from(err: GetDocumentVersionError) -> Self

Converts to this type from the input type.
Source§

impl From<GetFolderError> for Error

Source§

fn from(err: GetFolderError) -> Self

Converts to this type from the input type.
Source§

impl From<GetFolderPathError> for Error

Source§

fn from(err: GetFolderPathError) -> Self

Converts to this type from the input type.
Source§

impl From<GetResourcesError> for Error

Source§

fn from(err: GetResourcesError) -> Self

Converts to this type from the input type.
Source§

impl From<InitiateDocumentVersionUploadError> for Error

Source§

fn from(err: InitiateDocumentVersionUploadError) -> Self

Converts to this type from the input type.
Source§

impl From<RemoveAllResourcePermissionsError> for Error

Source§

fn from(err: RemoveAllResourcePermissionsError) -> Self

Converts to this type from the input type.
Source§

impl From<RemoveResourcePermissionError> for Error

Source§

fn from(err: RemoveResourcePermissionError) -> Self

Converts to this type from the input type.
Source§

impl From<RestoreDocumentVersionsError> for Error

Source§

fn from(err: RestoreDocumentVersionsError) -> Self

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<SearchResourcesError> for Error

Source§

fn from(err: SearchResourcesError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateDocumentError> for Error

Source§

fn from(err: UpdateDocumentError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateDocumentVersionError> for Error

Source§

fn from(err: UpdateDocumentVersionError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateFolderError> for Error

Source§

fn from(err: UpdateFolderError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateUserError> for Error

Source§

fn from(err: UpdateUserError) -> 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§

default 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,

Source§

impl<T> MaybeSendSync for T