Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error {
Show 17 variants AccessDeniedException(AccessDeniedException), ExpiredIteratorException(ExpiredIteratorException), ExpiredNextTokenException(ExpiredNextTokenException), InternalFailureException(InternalFailureException), InvalidArgumentException(InvalidArgumentException), KmsAccessDeniedException(KmsAccessDeniedException), KmsDisabledException(KmsDisabledException), KmsInvalidStateException(KmsInvalidStateException), KmsNotFoundException(KmsNotFoundException), KmsOptInRequired(KmsOptInRequired), KmsThrottlingException(KmsThrottlingException), LimitExceededException(LimitExceededException), ProvisionedThroughputExceededException(ProvisionedThroughputExceededException), ResourceInUseException(ResourceInUseException), ResourceNotFoundException(ResourceNotFoundException), 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)

Specifies that you do not have the permissions required to perform this operation.

§

ExpiredIteratorException(ExpiredIteratorException)

The provided iterator exceeds the maximum age allowed.

§

ExpiredNextTokenException(ExpiredNextTokenException)

The pagination token passed to the operation is expired.

§

InternalFailureException(InternalFailureException)

The processing of the request failed because of an unknown error, exception, or failure.

§

InvalidArgumentException(InvalidArgumentException)

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

§

KmsAccessDeniedException(KmsAccessDeniedException)

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

§

KmsDisabledException(KmsDisabledException)

The request was rejected because the specified customer master key (CMK) isn't enabled.

§

KmsInvalidStateException(KmsInvalidStateException)

The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide.

§

KmsNotFoundException(KmsNotFoundException)

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

§

KmsOptInRequired(KmsOptInRequired)

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

§

KmsThrottlingException(KmsThrottlingException)

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

§

LimitExceededException(LimitExceededException)

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

§

ProvisionedThroughputExceededException(ProvisionedThroughputExceededException)

The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.

§

ResourceInUseException(ResourceInUseException)

The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

§

ResourceNotFoundException(ResourceNotFoundException)

The requested resource could not be found. The stream might not be specified correctly.

§

ValidationException(ValidationException)

Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.

§

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

Source§

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

Source§

fn from(err: CreateStreamError) -> Self

Converts to this type from the input type.
Source§

impl From<DecreaseStreamRetentionPeriodError> for Error

Source§

fn from(err: DecreaseStreamRetentionPeriodError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteResourcePolicyError> for Error

Source§

fn from(err: DeleteResourcePolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteStreamError> for Error

Source§

fn from(err: DeleteStreamError) -> Self

Converts to this type from the input type.
Source§

impl From<DeregisterStreamConsumerError> for Error

Source§

fn from(err: DeregisterStreamConsumerError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeLimitsError> for Error

Source§

fn from(err: DescribeLimitsError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeStreamConsumerError> for Error

Source§

fn from(err: DescribeStreamConsumerError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeStreamError> for Error

Source§

fn from(err: DescribeStreamError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeStreamSummaryError> for Error

Source§

fn from(err: DescribeStreamSummaryError) -> Self

Converts to this type from the input type.
Source§

impl From<DisableEnhancedMonitoringError> for Error

Source§

fn from(err: DisableEnhancedMonitoringError) -> Self

Converts to this type from the input type.
Source§

impl From<EnableEnhancedMonitoringError> for Error

Source§

fn from(err: EnableEnhancedMonitoringError) -> Self

Converts to this type from the input type.
Source§

impl From<GetRecordsError> for Error

Source§

fn from(err: GetRecordsError) -> Self

Converts to this type from the input type.
Source§

impl From<GetResourcePolicyError> for Error

Source§

fn from(err: GetResourcePolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<GetShardIteratorError> for Error

Source§

fn from(err: GetShardIteratorError) -> Self

Converts to this type from the input type.
Source§

impl From<IncreaseStreamRetentionPeriodError> for Error

Source§

fn from(err: IncreaseStreamRetentionPeriodError) -> Self

Converts to this type from the input type.
Source§

impl From<ListShardsError> for Error

Source§

fn from(err: ListShardsError) -> Self

Converts to this type from the input type.
Source§

impl From<ListStreamConsumersError> for Error

Source§

fn from(err: ListStreamConsumersError) -> Self

Converts to this type from the input type.
Source§

impl From<ListStreamsError> for Error

Source§

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

Source§

fn from(err: ListTagsForStreamError) -> Self

Converts to this type from the input type.
Source§

impl From<MergeShardsError> for Error

Source§

fn from(err: MergeShardsError) -> Self

Converts to this type from the input type.
Source§

impl From<PutRecordError> for Error

Source§

fn from(err: PutRecordError) -> Self

Converts to this type from the input type.
Source§

impl From<PutRecordsError> for Error

Source§

fn from(err: PutRecordsError) -> Self

Converts to this type from the input type.
Source§

impl From<PutResourcePolicyError> for Error

Source§

fn from(err: PutResourcePolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<RegisterStreamConsumerError> for Error

Source§

fn from(err: RegisterStreamConsumerError) -> Self

Converts to this type from the input type.
Source§

impl From<RemoveTagsFromStreamError> for Error

Source§

fn from(err: RemoveTagsFromStreamError) -> Self

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<SplitShardError> for Error

Source§

fn from(err: SplitShardError) -> Self

Converts to this type from the input type.
Source§

impl From<StartStreamEncryptionError> for Error

Source§

fn from(err: StartStreamEncryptionError) -> Self

Converts to this type from the input type.
Source§

impl From<StopStreamEncryptionError> for Error

Source§

fn from(err: StopStreamEncryptionError) -> Self

Converts to this type from the input type.
Source§

impl From<SubscribeToShardError> for Error

Source§

fn from(err: SubscribeToShardError) -> Self

Converts to this type from the input type.
Source§

impl From<SubscribeToShardEventStreamError> for Error

Source§

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

Source§

fn from(err: UpdateShardCountError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateStreamModeError> for Error

Source§

fn from(err: UpdateStreamModeError) -> Self

Converts to this type from the input type.
Source§

impl<O, E> From<WaiterError<O, E>> for Error
where O: Debug + Send + Sync + 'static, E: Error + Send + Sync + 'static,

Source§

fn from(err: WaiterError<O, E>) -> 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,