#[non_exhaustive]pub struct UpdateAutoScalingGroupInput {Show 27 fields
pub auto_scaling_group_name: Option<String>,
pub launch_configuration_name: Option<String>,
pub launch_template: Option<LaunchTemplateSpecification>,
pub mixed_instances_policy: Option<MixedInstancesPolicy>,
pub min_size: Option<i32>,
pub max_size: Option<i32>,
pub desired_capacity: Option<i32>,
pub default_cooldown: Option<i32>,
pub availability_zones: Option<Vec<String>>,
pub health_check_type: Option<String>,
pub health_check_grace_period: Option<i32>,
pub placement_group: Option<String>,
pub vpc_zone_identifier: Option<String>,
pub termination_policies: Option<Vec<String>>,
pub new_instances_protected_from_scale_in: Option<bool>,
pub service_linked_role_arn: Option<String>,
pub max_instance_lifetime: Option<i32>,
pub capacity_rebalance: Option<bool>,
pub context: Option<String>,
pub desired_capacity_type: Option<String>,
pub default_instance_warmup: Option<i32>,
pub instance_maintenance_policy: Option<InstanceMaintenancePolicy>,
pub availability_zone_distribution: Option<AvailabilityZoneDistribution>,
pub availability_zone_impairment_policy: Option<AvailabilityZoneImpairmentPolicy>,
pub skip_zonal_shift_validation: Option<bool>,
pub capacity_reservation_specification: Option<CapacityReservationSpecification>,
pub instance_lifecycle_policy: Option<InstanceLifecyclePolicy>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.auto_scaling_group_name: Option<String>The name of the Auto Scaling group.
launch_configuration_name: Option<String>The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.
launch_template: Option<LaunchTemplateSpecification>The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy.
mixed_instances_policy: Option<MixedInstancesPolicy>The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
min_size: Option<i32>The minimum size of the Auto Scaling group.
max_size: Option<i32>The maximum size of the Auto Scaling group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
desired_capacity: Option<i32>The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
default_cooldown: Option<i32>Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
availability_zones: Option<Vec<String>>One or more Availability Zones for the group.
health_check_type: Option<String>A comma-separated value string of one or more health check types.
The valid values are EC2, EBS, ELB, and VPC_LATTICE. EC2 is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously set.
health_check_grace_period: Option<i32>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
placement_group: Option<String>The name of an existing placement group into which to launch your instances. To remove the placement group setting, pass an empty string for placement-group. For more information about placement groups, see Placement groups in the Amazon EC2 User Guide.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
vpc_zone_identifier: Option<String>A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify must reside in those Availability Zones.
termination_policies: Option<Vec<String>>A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
new_instances_protected_from_scale_in: Option<bool>Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
service_linked_role_arn: Option<String>The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.
max_instance_lifetime: Option<i32>The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). To clear a previously set value, specify a new value of 0. For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
capacity_rebalance: Option<bool>Enables or disables Capacity Rebalancing. If Capacity Rebalancing is disabled, proactive replacement of at-risk Spot Instances does not occur. For more information, see Capacity Rebalancing in Auto Scaling to replace at-risk Spot Instances in the Amazon EC2 Auto Scaling User Guide.
To suspend rebalancing across Availability Zones, use the SuspendProcesses API.
context: Option<String>Reserved.
desired_capacity_type: Option<String>The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
default_instance_warmup: Option<i32>The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.
instance_maintenance_policy: Option<InstanceMaintenancePolicy>An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
availability_zone_distribution: Option<AvailabilityZoneDistribution>The instance capacity distribution across Availability Zones.
availability_zone_impairment_policy: Option<AvailabilityZoneImpairmentPolicy>The policy for Availability Zone impairment.
skip_zonal_shift_validation: Option<bool>If you enable zonal shift with cross-zone disabled load balancers, capacity could become imbalanced across Availability Zones. To skip the validation, specify true. For more information, see Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.
capacity_reservation_specification: Option<CapacityReservationSpecification>The capacity reservation specification for the Auto Scaling group.
instance_lifecycle_policy: Option<InstanceLifecyclePolicy>The instance lifecycle policy for the Auto Scaling group. Use this to add, modify, or remove lifecycle policies that control instance behavior when an instance transitions through its lifecycle states. Configure retention triggers to specify when to preserve instances for manual intervention.
Implementations§
Source§impl UpdateAutoScalingGroupInput
impl UpdateAutoScalingGroupInput
Sourcepub fn auto_scaling_group_name(&self) -> Option<&str>
pub fn auto_scaling_group_name(&self) -> Option<&str>
The name of the Auto Scaling group.
Sourcepub fn launch_configuration_name(&self) -> Option<&str>
pub fn launch_configuration_name(&self) -> Option<&str>
The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.
Sourcepub fn launch_template(&self) -> Option<&LaunchTemplateSpecification>
pub fn launch_template(&self) -> Option<&LaunchTemplateSpecification>
The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy.
Sourcepub fn mixed_instances_policy(&self) -> Option<&MixedInstancesPolicy>
pub fn mixed_instances_policy(&self) -> Option<&MixedInstancesPolicy>
The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn max_size(&self) -> Option<i32>
pub fn max_size(&self) -> Option<i32>
The maximum size of the Auto Scaling group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
Sourcepub fn desired_capacity(&self) -> Option<i32>
pub fn desired_capacity(&self) -> Option<i32>
The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
Sourcepub fn default_cooldown(&self) -> Option<i32>
pub fn default_cooldown(&self) -> Option<i32>
Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn availability_zones(&self) -> &[String]
pub fn availability_zones(&self) -> &[String]
One or more Availability Zones for the group.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .availability_zones.is_none().
Sourcepub fn health_check_type(&self) -> Option<&str>
pub fn health_check_type(&self) -> Option<&str>
A comma-separated value string of one or more health check types.
The valid values are EC2, EBS, ELB, and VPC_LATTICE. EC2 is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously set.
Sourcepub fn health_check_grace_period(&self) -> Option<i32>
pub fn health_check_grace_period(&self) -> Option<i32>
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn placement_group(&self) -> Option<&str>
pub fn placement_group(&self) -> Option<&str>
The name of an existing placement group into which to launch your instances. To remove the placement group setting, pass an empty string for placement-group. For more information about placement groups, see Placement groups in the Amazon EC2 User Guide.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
Sourcepub fn vpc_zone_identifier(&self) -> Option<&str>
pub fn vpc_zone_identifier(&self) -> Option<&str>
A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify must reside in those Availability Zones.
Sourcepub fn termination_policies(&self) -> &[String]
pub fn termination_policies(&self) -> &[String]
A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .termination_policies.is_none().
Sourcepub fn new_instances_protected_from_scale_in(&self) -> Option<bool>
pub fn new_instances_protected_from_scale_in(&self) -> Option<bool>
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn service_linked_role_arn(&self) -> Option<&str>
pub fn service_linked_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn max_instance_lifetime(&self) -> Option<i32>
pub fn max_instance_lifetime(&self) -> Option<i32>
The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). To clear a previously set value, specify a new value of 0. For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn capacity_rebalance(&self) -> Option<bool>
pub fn capacity_rebalance(&self) -> Option<bool>
Enables or disables Capacity Rebalancing. If Capacity Rebalancing is disabled, proactive replacement of at-risk Spot Instances does not occur. For more information, see Capacity Rebalancing in Auto Scaling to replace at-risk Spot Instances in the Amazon EC2 Auto Scaling User Guide.
To suspend rebalancing across Availability Zones, use the SuspendProcesses API.
Sourcepub fn desired_capacity_type(&self) -> Option<&str>
pub fn desired_capacity_type(&self) -> Option<&str>
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
Sourcepub fn default_instance_warmup(&self) -> Option<i32>
pub fn default_instance_warmup(&self) -> Option<i32>
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.
Sourcepub fn instance_maintenance_policy(&self) -> Option<&InstanceMaintenancePolicy>
pub fn instance_maintenance_policy(&self) -> Option<&InstanceMaintenancePolicy>
An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn availability_zone_distribution(
&self,
) -> Option<&AvailabilityZoneDistribution>
pub fn availability_zone_distribution( &self, ) -> Option<&AvailabilityZoneDistribution>
The instance capacity distribution across Availability Zones.
Sourcepub fn availability_zone_impairment_policy(
&self,
) -> Option<&AvailabilityZoneImpairmentPolicy>
pub fn availability_zone_impairment_policy( &self, ) -> Option<&AvailabilityZoneImpairmentPolicy>
The policy for Availability Zone impairment.
Sourcepub fn skip_zonal_shift_validation(&self) -> Option<bool>
pub fn skip_zonal_shift_validation(&self) -> Option<bool>
If you enable zonal shift with cross-zone disabled load balancers, capacity could become imbalanced across Availability Zones. To skip the validation, specify true. For more information, see Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.
Sourcepub fn capacity_reservation_specification(
&self,
) -> Option<&CapacityReservationSpecification>
pub fn capacity_reservation_specification( &self, ) -> Option<&CapacityReservationSpecification>
The capacity reservation specification for the Auto Scaling group.
Sourcepub fn instance_lifecycle_policy(&self) -> Option<&InstanceLifecyclePolicy>
pub fn instance_lifecycle_policy(&self) -> Option<&InstanceLifecyclePolicy>
The instance lifecycle policy for the Auto Scaling group. Use this to add, modify, or remove lifecycle policies that control instance behavior when an instance transitions through its lifecycle states. Configure retention triggers to specify when to preserve instances for manual intervention.
Source§impl UpdateAutoScalingGroupInput
impl UpdateAutoScalingGroupInput
Sourcepub fn builder() -> UpdateAutoScalingGroupInputBuilder
pub fn builder() -> UpdateAutoScalingGroupInputBuilder
Creates a new builder-style object to manufacture UpdateAutoScalingGroupInput.
Trait Implementations§
Source§impl Clone for UpdateAutoScalingGroupInput
impl Clone for UpdateAutoScalingGroupInput
Source§fn clone(&self) -> UpdateAutoScalingGroupInput
fn clone(&self) -> UpdateAutoScalingGroupInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for UpdateAutoScalingGroupInput
impl Debug for UpdateAutoScalingGroupInput
impl StructuralPartialEq for UpdateAutoScalingGroupInput
Auto Trait Implementations§
impl Freeze for UpdateAutoScalingGroupInput
impl RefUnwindSafe for UpdateAutoScalingGroupInput
impl Send for UpdateAutoScalingGroupInput
impl Sync for UpdateAutoScalingGroupInput
impl Unpin for UpdateAutoScalingGroupInput
impl UnwindSafe for UpdateAutoScalingGroupInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);