Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error {
Show 16 variants AccessDeniedException(AccessDeniedException), ConcurrentModificationException(ConcurrentModificationException), ConflictException(ConflictException), IdempotentParameterMismatchException(IdempotentParameterMismatchException), InternalException(InternalException), InvalidInputException(InvalidInputException), InvalidStateException(InvalidStateException), LimitExceededException(LimitExceededException), PolicyLengthExceededException(PolicyLengthExceededException), PublicPolicyException(PublicPolicyException), ResourceAlreadyExistsException(ResourceAlreadyExistsException), ResourceInUseException(ResourceInUseException), ResourceNotFoundException(ResourceNotFoundException), SchemaRegistryUnavailableException(SchemaRegistryUnavailableException), ThrottlingException(ThrottlingException), 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)

The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.

§

ConcurrentModificationException(ConcurrentModificationException)

Another change to the resource is already in progress. Retry the request.

§

ConflictException(ConflictException)

A client-supplied precondition (e.g. ExpectedRevisionId on a resource-policy write) did not match the current state of the resource. Retrying the same request will fail again; re-read the resource and re-evaluate before retrying. A conditional request is not retry-safe on its own. If an earlier attempt committed but its response never reached the caller, retrying fails with this error, which is indistinguishable from another writer having won. Compare the resource’s current contents with what the request intended: a successful attempt stores a revision ID the caller never saw, so the revision alone cannot tell the two apart, but matching contents mean the change took effect.

§

IdempotentParameterMismatchException(IdempotentParameterMismatchException)

The request reuses the client token of an earlier request with different parameters. Use a new client token, or resend the earlier request unchanged.

§

InternalException(InternalException)

The request failed because of an internal service error. Retry the request.

§

InvalidInputException(InvalidInputException)

A request parameter is missing or not valid.

§

InvalidStateException(InvalidStateException)

The resource is not in a state that allows the operation. For example, an event bus that is still being created cannot accept events.

§

LimitExceededException(LimitExceededException)

The request would exceed a service quota for the account.

§

PolicyLengthExceededException(PolicyLengthExceededException)

The policy document is larger than the account’s resource policy size quota, or larger than the service maximum.

§

PublicPolicyException(PublicPolicyException)

The policy was rejected because it would grant public access to the event bus. A statement grants public access when its principal is a wildcard and no condition limits the callers to specific AWS accounts or principals. To fix it, replace the wildcard principal with specific principals, or add a condition that limits the callers to specific AWS accounts. Conditions on event content (events:source, events:detail-type, events:Metadata/*) do not identify the caller and do not make a wildcard principal non-public. Returned only for the “default” policy; the “AWS_RAM” policy is composed by AWS Resource Access Manager and never grants public access.

§

ResourceAlreadyExistsException(ResourceAlreadyExistsException)

A resource with the same name already exists.

§

ResourceInUseException(ResourceInUseException)

The resource is in use and cannot be deleted. For example, an event bus with subscribers or event sources cannot be deleted until they are deleted.

§

ResourceNotFoundException(ResourceNotFoundException)

The resource does not exist.

§

SchemaRegistryUnavailableException(SchemaRegistryUnavailableException)

The configured schema registry could not be reached. Retry the request.

§

ThrottlingException(ThrottlingException)

The request was throttled because it exceeds a request rate limit. Retry the request with backoff.

§

Unhandled(Unhandled)

👎Deprecated:

Matching Unhandled directly is not forwards compatible. Instead, match using a variable wildcard pattern and check .code():    err if err.code() == Some("SpecificExceptionCode") => { /* handle the error */ } See ProvideErrorMetadata for what information is available for the error.

An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).

Trait Implementations§

Source§

impl Debug for Error

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Error for Error

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<BuildError> for Error

Source§

fn from(value: BuildError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateEventBusError> for Error

Source§

fn from(err: CreateEventBusError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateEventSourceError> for Error

Source§

fn from(err: CreateEventSourceError) -> Self

Converts to this type from the input type.
Source§

impl From<CreateSubscriberError> for Error

Source§

fn from(err: CreateSubscriberError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteEventBusError> for Error

Source§

fn from(err: DeleteEventBusError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteEventSourceError> for Error

Source§

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

Source§

fn from(err: DeleteSubscriberError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeEventBusError> for Error

Source§

fn from(err: DescribeEventBusError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeEventSourceError> for Error

Source§

fn from(err: DescribeEventSourceError) -> Self

Converts to this type from the input type.
Source§

impl From<DescribeSubscriberError> for Error

Source§

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

Source§

fn from(err: ListEventBusesError) -> Self

Converts to this type from the input type.
Source§

impl From<ListEventSourcesError> for Error

Source§

fn from(err: ListEventSourcesError) -> Self

Converts to this type from the input type.
Source§

impl From<ListResourcePoliciesError> for Error

Source§

fn from(err: ListResourcePoliciesError) -> Self

Converts to this type from the input type.
Source§

impl From<ListSubscribersError> for Error

Source§

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

Source§

fn from(err: PutEventsError) -> Self

Converts to this type from the input type.
Source§

impl From<PutRawEventsError> for Error

Source§

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

Source§

fn from(err: RevokeResourceError) -> Self

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<TagResourceError> for Error

Source§

fn from(err: TagResourceError) -> Self

Converts to this type from the input type.
Source§

impl From<UntagResourceError> for Error

Source§

fn from(err: UntagResourceError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateEventBusError> for Error

Source§

fn from(err: UpdateEventBusError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateEventSourceError> for Error

Source§

fn from(err: UpdateEventSourceError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateSubscriberError> for Error

Source§

fn from(err: UpdateSubscriberError) -> 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 !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Freeze for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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