Enum Error

Source
#[non_exhaustive]
pub enum Error {
Show 19 variants AccessDeniedException(AccessDeniedException), BadDocumentException(BadDocumentException), ConflictException(ConflictException), DocumentTooLargeException(DocumentTooLargeException), HumanLoopQuotaExceededException(HumanLoopQuotaExceededException), IdempotentParameterMismatchException(IdempotentParameterMismatchException), InternalServerError(InternalServerError), InvalidJobIdException(InvalidJobIdException), InvalidKmsKeyException(InvalidKmsKeyException), InvalidParameterException(InvalidParameterException), InvalidS3ObjectException(InvalidS3ObjectException), LimitExceededException(LimitExceededException), ProvisionedThroughputExceededException(ProvisionedThroughputExceededException), ResourceNotFoundException(ResourceNotFoundException), ServiceQuotaExceededException(ServiceQuotaExceededException), ThrottlingException(ThrottlingException), UnsupportedDocumentException(UnsupportedDocumentException), 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.
§

AccessDeniedException(AccessDeniedException)

You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.

§

BadDocumentException(BadDocumentException)

Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.

§

ConflictException(ConflictException)

Updating or deleting a resource can cause an inconsistent state.

§

DocumentTooLargeException(DocumentTooLargeException)

The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.

§

HumanLoopQuotaExceededException(HumanLoopQuotaExceededException)

Indicates you have exceeded the maximum number of active human in the loop workflows available

§

IdempotentParameterMismatchException(IdempotentParameterMismatchException)

A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

§

InternalServerError(InternalServerError)

Amazon Textract experienced a service issue. Try your call again.

§

InvalidJobIdException(InvalidJobIdException)

An invalid job identifier was passed to an asynchronous analysis operation.

§

InvalidKmsKeyException(InvalidKmsKeyException)

Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.

§

InvalidParameterException(InvalidParameterException)

An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

§

InvalidS3ObjectException(InvalidS3ObjectException)

Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3

§

LimitExceededException(LimitExceededException)

An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

§

ProvisionedThroughputExceededException(ProvisionedThroughputExceededException)

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

§

ResourceNotFoundException(ResourceNotFoundException)

Returned when an operation tried to access a nonexistent resource.

§

ServiceQuotaExceededException(ServiceQuotaExceededException)

Returned when a request cannot be completed as it would exceed a maximum service quota.

§

ThrottlingException(ThrottlingException)

Amazon Textract is temporarily unable to process the request. Try your call again.

§

UnsupportedDocumentException(UnsupportedDocumentException)

The format of the input document isn't supported. Documents for operations can be in PNG, JPEG, PDF, or TIFF format.

§

ValidationException(ValidationException)

Indicates that a request was not valid. Check request for proper formatting.

§

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

Source§

fn from(err: AnalyzeDocumentError) -> Self

Converts to this type from the input type.
Source§

impl From<AnalyzeExpenseError> for Error

Source§

fn from(err: AnalyzeExpenseError) -> Self

Converts to this type from the input type.
Source§

impl From<AnalyzeIDError> for Error

Source§

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

Source§

fn from(err: CreateAdapterError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateAdapterVersionError> for Error

Source§

fn from(err: CreateAdapterVersionError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteAdapterError> for Error

Source§

fn from(err: DeleteAdapterError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteAdapterVersionError> for Error

Source§

fn from(err: DeleteAdapterVersionError) -> Self

Converts to this type from the input type.
Source§

impl From<DetectDocumentTextError> for Error

Source§

fn from(err: DetectDocumentTextError) -> Self

Converts to this type from the input type.
Source§

impl From<GetAdapterError> for Error

Source§

fn from(err: GetAdapterError) -> Self

Converts to this type from the input type.
Source§

impl From<GetAdapterVersionError> for Error

Source§

fn from(err: GetAdapterVersionError) -> Self

Converts to this type from the input type.
Source§

impl From<GetDocumentAnalysisError> for Error

Source§

fn from(err: GetDocumentAnalysisError) -> Self

Converts to this type from the input type.
Source§

impl From<GetDocumentTextDetectionError> for Error

Source§

fn from(err: GetDocumentTextDetectionError) -> Self

Converts to this type from the input type.
Source§

impl From<GetExpenseAnalysisError> for Error

Source§

fn from(err: GetExpenseAnalysisError) -> Self

Converts to this type from the input type.
Source§

impl From<GetLendingAnalysisError> for Error

Source§

fn from(err: GetLendingAnalysisError) -> Self

Converts to this type from the input type.
Source§

impl From<GetLendingAnalysisSummaryError> for Error

Source§

fn from(err: GetLendingAnalysisSummaryError) -> Self

Converts to this type from the input type.
Source§

impl From<ListAdapterVersionsError> for Error

Source§

fn from(err: ListAdapterVersionsError) -> Self

Converts to this type from the input type.
Source§

impl From<ListAdaptersError> for Error

Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<StartDocumentAnalysisError> for Error

Source§

fn from(err: StartDocumentAnalysisError) -> Self

Converts to this type from the input type.
Source§

impl From<StartDocumentTextDetectionError> for Error

Source§

fn from(err: StartDocumentTextDetectionError) -> Self

Converts to this type from the input type.
Source§

impl From<StartExpenseAnalysisError> for Error

Source§

fn from(err: StartExpenseAnalysisError) -> Self

Converts to this type from the input type.
Source§

impl From<StartLendingAnalysisError> for Error

Source§

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

Source§

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