AutoScalingGroup

Struct AutoScalingGroup 

Source
#[non_exhaustive]
pub struct AutoScalingGroup {
Show 39 fields pub auto_scaling_group_name: Option<String>, pub auto_scaling_group_arn: 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 predicted_capacity: Option<i32>, pub default_cooldown: Option<i32>, pub availability_zones: Option<Vec<String>>, pub load_balancer_names: Option<Vec<String>>, pub target_group_arns: Option<Vec<String>>, pub health_check_type: Option<String>, pub health_check_grace_period: Option<i32>, pub instances: Option<Vec<Instance>>, pub created_time: Option<DateTime>, pub suspended_processes: Option<Vec<SuspendedProcess>>, pub placement_group: Option<String>, pub vpc_zone_identifier: Option<String>, pub enabled_metrics: Option<Vec<EnabledMetric>>, pub status: Option<String>, pub tags: Option<Vec<TagDescription>>, 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 warm_pool_configuration: Option<WarmPoolConfiguration>, pub warm_pool_size: Option<i32>, pub context: Option<String>, pub desired_capacity_type: Option<String>, pub default_instance_warmup: Option<i32>, pub traffic_sources: Option<Vec<TrafficSourceIdentifier>>, pub instance_maintenance_policy: Option<InstanceMaintenancePolicy>, pub availability_zone_distribution: Option<AvailabilityZoneDistribution>, pub availability_zone_impairment_policy: Option<AvailabilityZoneImpairmentPolicy>, pub capacity_reservation_specification: Option<CapacityReservationSpecification>, pub instance_lifecycle_policy: Option<InstanceLifecyclePolicy>,
}
Expand description

Describes an Auto Scaling group.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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.

§auto_scaling_group_arn: Option<String>

The Amazon Resource Name (ARN) of the Auto Scaling group.

§launch_configuration_name: Option<String>

The name of the associated launch configuration.

§launch_template: Option<LaunchTemplateSpecification>

The launch template for the group.

§mixed_instances_policy: Option<MixedInstancesPolicy>

The mixed instances policy for the group.

§min_size: Option<i32>

The minimum size of the group.

§max_size: Option<i32>

The maximum size of the group.

§desired_capacity: Option<i32>

The desired size of the group.

§predicted_capacity: Option<i32>

The predicted capacity of the group when it has a predictive scaling policy.

§default_cooldown: Option<i32>

The duration of the default cooldown period, in seconds.

§availability_zones: Option<Vec<String>>

One or more Availability Zones for the group.

§load_balancer_names: Option<Vec<String>>

One or more load balancers associated with the group.

§target_group_arns: Option<Vec<String>>

The Amazon Resource Names (ARN) of the target groups for your load balancer.

§health_check_type: Option<String>

A comma-separated value string of one or more health check types.

§health_check_grace_period: Option<i32>

The duration of the health check grace period, in seconds.

§instances: Option<Vec<Instance>>

The EC2 instances associated with the group.

§created_time: Option<DateTime>

The date and time the group was created.

§suspended_processes: Option<Vec<SuspendedProcess>>

The suspended processes associated with the group.

§placement_group: Option<String>

The name of the placement group into which to launch your instances, if any.

§vpc_zone_identifier: Option<String>

One or more subnet IDs, if applicable, separated by commas.

§enabled_metrics: Option<Vec<EnabledMetric>>

The metrics enabled for the group.

§status: Option<String>

The current state of the group when the DeleteAutoScalingGroup operation is in progress.

§tags: Option<Vec<TagDescription>>

The tags for the group.

§termination_policies: Option<Vec<String>>

The termination policies for the group.

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

§max_instance_lifetime: Option<i32>

The maximum amount of time, in seconds, that an instance can be in service.

Valid Range: Minimum value of 0.

§capacity_rebalance: Option<bool>

Indicates whether Capacity Rebalancing is enabled.

§warm_pool_configuration: Option<WarmPoolConfiguration>

The warm pool for the group.

§warm_pool_size: Option<i32>

The current size of the warm pool.

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

§default_instance_warmup: Option<i32>

The duration of the default instance warmup, in seconds.

§traffic_sources: Option<Vec<TrafficSourceIdentifier>>

The traffic sources associated with this Auto Scaling group.

§instance_maintenance_policy: Option<InstanceMaintenancePolicy>

An instance maintenance policy.

§availability_zone_distribution: Option<AvailabilityZoneDistribution>

The instance capacity distribution across Availability Zones.

§availability_zone_impairment_policy: Option<AvailabilityZoneImpairmentPolicy>

The Availability Zone impairment policy.

§capacity_reservation_specification: Option<CapacityReservationSpecification>

The capacity reservation specification.

§instance_lifecycle_policy: Option<InstanceLifecyclePolicy>

The instance lifecycle policy applied to this Auto Scaling group. This policy determines instance behavior when an instance transitions through its lifecycle states. It provides additional control over graceful instance management processes.

Implementations§

Source§

impl AutoScalingGroup

Source

pub fn auto_scaling_group_name(&self) -> Option<&str>

The name of the Auto Scaling group.

Source

pub fn auto_scaling_group_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the Auto Scaling group.

Source

pub fn launch_configuration_name(&self) -> Option<&str>

The name of the associated launch configuration.

Source

pub fn launch_template(&self) -> Option<&LaunchTemplateSpecification>

The launch template for the group.

Source

pub fn mixed_instances_policy(&self) -> Option<&MixedInstancesPolicy>

The mixed instances policy for the group.

Source

pub fn min_size(&self) -> Option<i32>

The minimum size of the group.

Source

pub fn max_size(&self) -> Option<i32>

The maximum size of the group.

Source

pub fn desired_capacity(&self) -> Option<i32>

The desired size of the group.

Source

pub fn predicted_capacity(&self) -> Option<i32>

The predicted capacity of the group when it has a predictive scaling policy.

Source

pub fn default_cooldown(&self) -> Option<i32>

The duration of the default cooldown period, in seconds.

Source

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

Source

pub fn load_balancer_names(&self) -> &[String]

One or more load balancers associated with 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 .load_balancer_names.is_none().

Source

pub fn target_group_arns(&self) -> &[String]

The Amazon Resource Names (ARN) of the target groups for your load balancer.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_group_arns.is_none().

Source

pub fn health_check_type(&self) -> Option<&str>

A comma-separated value string of one or more health check types.

Source

pub fn health_check_grace_period(&self) -> Option<i32>

The duration of the health check grace period, in seconds.

Source

pub fn instances(&self) -> &[Instance]

The EC2 instances associated with 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 .instances.is_none().

Source

pub fn created_time(&self) -> Option<&DateTime>

The date and time the group was created.

Source

pub fn suspended_processes(&self) -> &[SuspendedProcess]

The suspended processes associated with 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 .suspended_processes.is_none().

Source

pub fn placement_group(&self) -> Option<&str>

The name of the placement group into which to launch your instances, if any.

Source

pub fn vpc_zone_identifier(&self) -> Option<&str>

One or more subnet IDs, if applicable, separated by commas.

Source

pub fn enabled_metrics(&self) -> &[EnabledMetric]

The metrics enabled 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 .enabled_metrics.is_none().

Source

pub fn status(&self) -> Option<&str>

The current state of the group when the DeleteAutoScalingGroup operation is in progress.

Source

pub fn tags(&self) -> &[TagDescription]

The tags 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 .tags.is_none().

Source

pub fn termination_policies(&self) -> &[String]

The termination policies 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 .termination_policies.is_none().

Source

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.

Source

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.

Source

pub fn max_instance_lifetime(&self) -> Option<i32>

The maximum amount of time, in seconds, that an instance can be in service.

Valid Range: Minimum value of 0.

Source

pub fn capacity_rebalance(&self) -> Option<bool>

Indicates whether Capacity Rebalancing is enabled.

Source

pub fn warm_pool_configuration(&self) -> Option<&WarmPoolConfiguration>

The warm pool for the group.

Source

pub fn warm_pool_size(&self) -> Option<i32>

The current size of the warm pool.

Source

pub fn context(&self) -> Option<&str>

Reserved.

Source

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.

Source

pub fn default_instance_warmup(&self) -> Option<i32>

The duration of the default instance warmup, in seconds.

Source

pub fn traffic_sources(&self) -> &[TrafficSourceIdentifier]

The traffic sources associated with this Auto Scaling 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 .traffic_sources.is_none().

Source

pub fn instance_maintenance_policy(&self) -> Option<&InstanceMaintenancePolicy>

An instance maintenance policy.

Source

pub fn availability_zone_distribution( &self, ) -> Option<&AvailabilityZoneDistribution>

The instance capacity distribution across Availability Zones.

Source

pub fn availability_zone_impairment_policy( &self, ) -> Option<&AvailabilityZoneImpairmentPolicy>

The Availability Zone impairment policy.

Source

pub fn capacity_reservation_specification( &self, ) -> Option<&CapacityReservationSpecification>

The capacity reservation specification.

Source

pub fn instance_lifecycle_policy(&self) -> Option<&InstanceLifecyclePolicy>

The instance lifecycle policy applied to this Auto Scaling group. This policy determines instance behavior when an instance transitions through its lifecycle states. It provides additional control over graceful instance management processes.

Source§

impl AutoScalingGroup

Source

pub fn builder() -> AutoScalingGroupBuilder

Creates a new builder-style object to manufacture AutoScalingGroup.

Trait Implementations§

Source§

impl Clone for AutoScalingGroup

Source§

fn clone(&self) -> AutoScalingGroup

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AutoScalingGroup

Source§

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

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

impl PartialEq for AutoScalingGroup

Source§

fn eq(&self, other: &AutoScalingGroup) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for AutoScalingGroup

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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