Enum UpdateDeploymentGroupError

Source
#[non_exhaustive]
pub enum UpdateDeploymentGroupError {
Show 32 variants AlarmsLimitExceededException(AlarmsLimitExceededException), ApplicationDoesNotExistException(ApplicationDoesNotExistException), ApplicationNameRequiredException(ApplicationNameRequiredException), DeploymentConfigDoesNotExistException(DeploymentConfigDoesNotExistException), DeploymentGroupAlreadyExistsException(DeploymentGroupAlreadyExistsException), DeploymentGroupDoesNotExistException(DeploymentGroupDoesNotExistException), DeploymentGroupNameRequiredException(DeploymentGroupNameRequiredException), EcsServiceMappingLimitExceededException(EcsServiceMappingLimitExceededException), InvalidAlarmConfigException(InvalidAlarmConfigException), InvalidApplicationNameException(InvalidApplicationNameException), InvalidAutoRollbackConfigException(InvalidAutoRollbackConfigException), InvalidAutoScalingGroupException(InvalidAutoScalingGroupException), InvalidBlueGreenDeploymentConfigurationException(InvalidBlueGreenDeploymentConfigurationException), InvalidDeploymentConfigNameException(InvalidDeploymentConfigNameException), InvalidDeploymentGroupNameException(InvalidDeploymentGroupNameException), InvalidDeploymentStyleException(InvalidDeploymentStyleException), InvalidEc2TagCombinationException(InvalidEc2TagCombinationException), InvalidEc2TagException(InvalidEc2TagException), InvalidEcsServiceException(InvalidEcsServiceException), InvalidInputException(InvalidInputException), InvalidLoadBalancerInfoException(InvalidLoadBalancerInfoException), InvalidOnPremisesTagCombinationException(InvalidOnPremisesTagCombinationException), InvalidRoleException(InvalidRoleException), InvalidTagException(InvalidTagException), InvalidTargetGroupPairException(InvalidTargetGroupPairException), InvalidTrafficRoutingConfigurationException(InvalidTrafficRoutingConfigurationException), InvalidTriggerConfigException(InvalidTriggerConfigException), LifecycleHookLimitExceededException(LifecycleHookLimitExceededException), TagSetListLimitExceededException(TagSetListLimitExceededException), ThrottlingException(ThrottlingException), TriggerTargetsLimitExceededException(TriggerTargetsLimitExceededException), Unhandled(Unhandled),
}
Expand description

Error type for the UpdateDeploymentGroupError operation.

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.
§

AlarmsLimitExceededException(AlarmsLimitExceededException)

The maximum number of alarms for a deployment group (10) was exceeded.

§

ApplicationDoesNotExistException(ApplicationDoesNotExistException)

The application does not exist with the user or Amazon Web Services account.

§

ApplicationNameRequiredException(ApplicationNameRequiredException)

The minimum number of required application names was not specified.

§

DeploymentConfigDoesNotExistException(DeploymentConfigDoesNotExistException)

The deployment configuration does not exist with the user or Amazon Web Services account.

§

DeploymentGroupAlreadyExistsException(DeploymentGroupAlreadyExistsException)

A deployment group with the specified name with the user or Amazon Web Services account already exists.

§

DeploymentGroupDoesNotExistException(DeploymentGroupDoesNotExistException)

The named deployment group with the user or Amazon Web Services account does not exist.

§

DeploymentGroupNameRequiredException(DeploymentGroupNameRequiredException)

The deployment group name was not specified.

§

EcsServiceMappingLimitExceededException(EcsServiceMappingLimitExceededException)

The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.

§

InvalidAlarmConfigException(InvalidAlarmConfigException)

The format of the alarm configuration is invalid. Possible causes include:

  • The alarm list is null.

  • The alarm object is null.

  • The alarm name is empty or null or exceeds the limit of 255 characters.

  • Two alarms with the same name have been specified.

  • The alarm configuration is enabled, but the alarm list is empty.

§

InvalidApplicationNameException(InvalidApplicationNameException)

The application name was specified in an invalid format.

§

InvalidAutoRollbackConfigException(InvalidAutoRollbackConfigException)

The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.

§

InvalidAutoScalingGroupException(InvalidAutoScalingGroupException)

The Auto Scaling group was specified in an invalid format or does not exist.

§

InvalidBlueGreenDeploymentConfigurationException(InvalidBlueGreenDeploymentConfigurationException)

The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.

§

InvalidDeploymentConfigNameException(InvalidDeploymentConfigNameException)

The deployment configuration name was specified in an invalid format.

§

InvalidDeploymentGroupNameException(InvalidDeploymentGroupNameException)

The deployment group name was specified in an invalid format.

§

InvalidDeploymentStyleException(InvalidDeploymentStyleException)

An invalid deployment style was specified. Valid deployment types include "IN_PLACE" and "BLUE_GREEN." Valid deployment options include "WITH_TRAFFIC_CONTROL" and "WITHOUT_TRAFFIC_CONTROL."

§

InvalidEc2TagCombinationException(InvalidEc2TagCombinationException)

A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.

§

InvalidEc2TagException(InvalidEc2TagException)

The tag was specified in an invalid format.

§

InvalidEcsServiceException(InvalidEcsServiceException)

The Amazon ECS service identifier is not valid.

§

InvalidInputException(InvalidInputException)

The input was specified in an invalid format.

§

InvalidLoadBalancerInfoException(InvalidLoadBalancerInfoException)

An invalid load balancer name, or no load balancer name, was specified.

§

InvalidOnPremisesTagCombinationException(InvalidOnPremisesTagCombinationException)

A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.

§

InvalidRoleException(InvalidRoleException)

The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.

§

InvalidTagException(InvalidTagException)

The tag was specified in an invalid format.

§

InvalidTargetGroupPairException(InvalidTargetGroupPairException)

A target group pair associated with this deployment is not valid.

§

InvalidTrafficRoutingConfigurationException(InvalidTrafficRoutingConfigurationException)

The configuration that specifies how traffic is routed during a deployment is invalid.

§

InvalidTriggerConfigException(InvalidTriggerConfigException)

The trigger was specified in an invalid format.

§

LifecycleHookLimitExceededException(LifecycleHookLimitExceededException)

The limit for lifecycle hooks was exceeded.

§

TagSetListLimitExceededException(TagSetListLimitExceededException)

The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.

§

ThrottlingException(ThrottlingException)

An API function was called too frequently.

§

TriggerTargetsLimitExceededException(TriggerTargetsLimitExceededException)

The maximum allowed number of triggers was exceeded.

§

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).

Implementations§

Source§

impl UpdateDeploymentGroupError

Source

pub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self

Creates the UpdateDeploymentGroupError::Unhandled variant from any error type.

Source

pub fn generic(err: ErrorMetadata) -> Self

Creates the UpdateDeploymentGroupError::Unhandled variant from an ErrorMetadata.

Source

pub fn meta(&self) -> &ErrorMetadata

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

Source

pub fn is_alarms_limit_exceeded_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::AlarmsLimitExceededException.

Source

pub fn is_application_does_not_exist_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::ApplicationDoesNotExistException.

Source

pub fn is_application_name_required_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::ApplicationNameRequiredException.

Source

pub fn is_deployment_config_does_not_exist_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::DeploymentConfigDoesNotExistException.

Source

pub fn is_deployment_group_already_exists_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::DeploymentGroupAlreadyExistsException.

Source

pub fn is_deployment_group_does_not_exist_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::DeploymentGroupDoesNotExistException.

Source

pub fn is_deployment_group_name_required_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::DeploymentGroupNameRequiredException.

Source

pub fn is_ecs_service_mapping_limit_exceeded_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::EcsServiceMappingLimitExceededException.

Source

pub fn is_invalid_alarm_config_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidAlarmConfigException.

Source

pub fn is_invalid_application_name_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidApplicationNameException.

Source

pub fn is_invalid_auto_rollback_config_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidAutoRollbackConfigException.

Source

pub fn is_invalid_auto_scaling_group_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidAutoScalingGroupException.

Source

pub fn is_invalid_blue_green_deployment_configuration_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidBlueGreenDeploymentConfigurationException.

Source

pub fn is_invalid_deployment_config_name_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidDeploymentConfigNameException.

Source

pub fn is_invalid_deployment_group_name_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidDeploymentGroupNameException.

Source

pub fn is_invalid_deployment_style_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidDeploymentStyleException.

Source

pub fn is_invalid_ec2_tag_combination_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidEc2TagCombinationException.

Source

pub fn is_invalid_ec2_tag_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidEc2TagException.

Source

pub fn is_invalid_ecs_service_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidEcsServiceException.

Source

pub fn is_invalid_input_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidInputException.

Source

pub fn is_invalid_load_balancer_info_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidLoadBalancerInfoException.

Source

pub fn is_invalid_on_premises_tag_combination_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidOnPremisesTagCombinationException.

Source

pub fn is_invalid_role_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidRoleException.

Source

pub fn is_invalid_tag_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidTagException.

Source

pub fn is_invalid_target_group_pair_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidTargetGroupPairException.

Source

pub fn is_invalid_traffic_routing_configuration_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidTrafficRoutingConfigurationException.

Source

pub fn is_invalid_trigger_config_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::InvalidTriggerConfigException.

Source

pub fn is_lifecycle_hook_limit_exceeded_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::LifecycleHookLimitExceededException.

Source

pub fn is_tag_set_list_limit_exceeded_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::TagSetListLimitExceededException.

Source

pub fn is_throttling_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::ThrottlingException.

Source

pub fn is_trigger_targets_limit_exceeded_exception(&self) -> bool

Returns true if the error kind is UpdateDeploymentGroupError::TriggerTargetsLimitExceededException.

Trait Implementations§

Source§

impl CreateUnhandledError for UpdateDeploymentGroupError

Source§

fn create_unhandled_error( source: Box<dyn Error + Send + Sync + 'static>, meta: Option<ErrorMetadata>, ) -> Self

Creates an unhandled error variant with the given source and error metadata.
Source§

impl Debug for UpdateDeploymentGroupError

Source§

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

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

impl Display for UpdateDeploymentGroupError

Source§

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

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

impl Error for UpdateDeploymentGroupError

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

Source§

fn from(err: UpdateDeploymentGroupError) -> Self

Converts to this type from the input type.
Source§

impl ProvideErrorKind for UpdateDeploymentGroupError

Source§

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

Returns the code for this error if one exists
Source§

fn retryable_error_kind(&self) -> Option<ErrorKind>

Returns the ErrorKind when the error is modeled as retryable Read more
Source§

impl ProvideErrorMetadata for UpdateDeploymentGroupError

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 UpdateDeploymentGroupError

Source§

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

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

Auto Trait Implementations§

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,