aws_sdk_verifiedpermissions

Enum Error

Source
#[non_exhaustive]
pub enum Error { AccessDeniedException(AccessDeniedException), ConflictException(ConflictException), InternalServerException(InternalServerException), ResourceNotFoundException(ResourceNotFoundException), ServiceQuotaExceededException(ServiceQuotaExceededException), ThrottlingException(ThrottlingException), 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 don't have sufficient access to perform this action.

§

ConflictException(ConflictException)

The request failed because another request to modify a resource occurred at the same.

§

InternalServerException(InternalServerException)

The request failed because of an internal error. Try your request again later

§

ResourceNotFoundException(ResourceNotFoundException)

The request failed because it references a resource that doesn't exist.

§

ServiceQuotaExceededException(ServiceQuotaExceededException)

The request failed because it would cause a service quota to be exceeded.

§

ThrottlingException(ThrottlingException)

The request failed because it exceeded a throttling quota.

§

ValidationException(ValidationException)

The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.

The possible reasons include the following:

  • UnrecognizedEntityType

    The policy includes an entity type that isn't found in the schema.

  • UnrecognizedActionId

    The policy includes an action id that isn't found in the schema.

  • InvalidActionApplication

    The policy includes an action that, according to the schema, doesn't support the specified principal and resource.

  • UnexpectedType

    The policy included an operand that isn't a valid type for the specified operation.

  • IncompatibleTypes

    The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.

  • MissingAttribute

    The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

  • UnsafeOptionalAttributeAccess

    The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.

  • ImpossiblePolicy

    Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.

  • WrongNumberArguments

    The policy references an extension type with the wrong number of arguments.

  • FunctionArgumentValidationError

    Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.

§

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

Source§

fn from(err: BatchGetPolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<BatchIsAuthorizedError> for Error

Source§

fn from(err: BatchIsAuthorizedError) -> Self

Converts to this type from the input type.
Source§

impl From<BatchIsAuthorizedWithTokenError> for Error

Source§

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

Source§

fn from(err: CreateIdentitySourceError) -> Self

Converts to this type from the input type.
Source§

impl From<CreatePolicyError> for Error

Source§

fn from(err: CreatePolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<CreatePolicyStoreError> for Error

Source§

fn from(err: CreatePolicyStoreError) -> Self

Converts to this type from the input type.
Source§

impl From<CreatePolicyTemplateError> for Error

Source§

fn from(err: CreatePolicyTemplateError) -> Self

Converts to this type from the input type.
Source§

impl From<DeleteIdentitySourceError> for Error

Source§

fn from(err: DeleteIdentitySourceError) -> Self

Converts to this type from the input type.
Source§

impl From<DeletePolicyError> for Error

Source§

fn from(err: DeletePolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<DeletePolicyStoreError> for Error

Source§

fn from(err: DeletePolicyStoreError) -> Self

Converts to this type from the input type.
Source§

impl From<DeletePolicyTemplateError> for Error

Source§

fn from(err: DeletePolicyTemplateError) -> Self

Converts to this type from the input type.
Source§

impl From<GetIdentitySourceError> for Error

Source§

fn from(err: GetIdentitySourceError) -> Self

Converts to this type from the input type.
Source§

impl From<GetPolicyError> for Error

Source§

fn from(err: GetPolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<GetPolicyStoreError> for Error

Source§

fn from(err: GetPolicyStoreError) -> Self

Converts to this type from the input type.
Source§

impl From<GetPolicyTemplateError> for Error

Source§

fn from(err: GetPolicyTemplateError) -> Self

Converts to this type from the input type.
Source§

impl From<GetSchemaError> for Error

Source§

fn from(err: GetSchemaError) -> Self

Converts to this type from the input type.
Source§

impl From<IsAuthorizedError> for Error

Source§

fn from(err: IsAuthorizedError) -> Self

Converts to this type from the input type.
Source§

impl From<IsAuthorizedWithTokenError> for Error

Source§

fn from(err: IsAuthorizedWithTokenError) -> Self

Converts to this type from the input type.
Source§

impl From<ListIdentitySourcesError> for Error

Source§

fn from(err: ListIdentitySourcesError) -> Self

Converts to this type from the input type.
Source§

impl From<ListPoliciesError> for Error

Source§

fn from(err: ListPoliciesError) -> Self

Converts to this type from the input type.
Source§

impl From<ListPolicyStoresError> for Error

Source§

fn from(err: ListPolicyStoresError) -> Self

Converts to this type from the input type.
Source§

impl From<ListPolicyTemplatesError> for Error

Source§

fn from(err: ListPolicyTemplatesError) -> Self

Converts to this type from the input type.
Source§

impl From<PutSchemaError> for Error

Source§

fn from(err: PutSchemaError) -> Self

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<UpdateIdentitySourceError> for Error

Source§

fn from(err: UpdateIdentitySourceError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdatePolicyError> for Error

Source§

fn from(err: UpdatePolicyError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdatePolicyStoreError> for Error

Source§

fn from(err: UpdatePolicyStoreError) -> Self

Converts to this type from the input type.
Source§

impl From<UpdatePolicyTemplateError> for Error

Source§

fn from(err: UpdatePolicyTemplateError) -> Self

Converts to this type from the input type.
Source§

impl ProvideErrorMetadata for Error

Source§

fn meta(&self) -> &ErrorMetadata

Returns error metadata, which includes the error code, message, request ID, and potentially additional information.
Source§

fn code(&self) -> Option<&str>

Returns the error code if it’s available.
Source§

fn message(&self) -> Option<&str>

Returns the error message, if there is one.
Source§

impl RequestId for Error

Source§

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

Auto Trait Implementations§

§

impl Freeze for Error

§

impl !RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl !UnwindSafe for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlack.

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightRed.

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightGreen.

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightYellow.

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightMagenta.

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightCyan.

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightWhite.

§Example
println!("{}", value.bright_white());
Source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to Color::Primary.

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlack.

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightRed.

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightGreen.

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightYellow.

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlue.

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightMagenta.

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightCyan.

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightWhite.

§Example
println!("{}", value.on_bright_white());
Source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

§Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

§Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

§Example
println!("{}", value.strike());
Source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

§Example
println!("{}", value.linger());
Source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to Quirk::Clear.

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Resetting.

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

§Example
println!("{}", value.on_bright());
Source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T