AutoScalingGroupBuilder

aws_sdk_autoscaling::types::builders

Struct AutoScalingGroupBuilder 

Source 
#[non_exhaustive]
pub struct AutoScalingGroupBuilder { /* private fields */ }
Expand description

A builder for AutoScalingGroup.

Implementations§

Source§

impl AutoScalingGroupBuilder

Source

pub fn auto_scaling_group_name(self, input: impl Into<String>) -> Self

The name of the Auto Scaling group.

This field is required.
Source

pub fn set_auto_scaling_group_name(self, input: Option<String>) -> Self

The name of the Auto Scaling group.

Source

pub fn get_auto_scaling_group_name(&self) -> &Option<String>

The name of the Auto Scaling group.

Source

pub fn auto_scaling_group_arn(self, input: impl Into<String>) -> Self

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

Source

pub fn set_auto_scaling_group_arn(self, input: Option<String>) -> Self

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

Source

pub fn get_auto_scaling_group_arn(&self) -> &Option<String>

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

Source

pub fn launch_configuration_name(self, input: impl Into<String>) -> Self

The name of the associated launch configuration.

Source

pub fn set_launch_configuration_name(self, input: Option<String>) -> Self

The name of the associated launch configuration.

Source

pub fn get_launch_configuration_name(&self) -> &Option<String>

The name of the associated launch configuration.

Source

pub fn launch_template(self, input: LaunchTemplateSpecification) -> Self

The launch template for the group.

Source

pub fn set_launch_template( self, input: Option<LaunchTemplateSpecification>, ) -> Self

The launch template for the group.

Source

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

The launch template for the group.

Source

pub fn mixed_instances_policy(self, input: MixedInstancesPolicy) -> Self

The mixed instances policy for the group.

Source

pub fn set_mixed_instances_policy( self, input: Option<MixedInstancesPolicy>, ) -> Self

The mixed instances policy for the group.

Source

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

The mixed instances policy for the group.

Source

pub fn min_size(self, input: i32) -> Self

The minimum size of the group.

This field is required.
Source

pub fn set_min_size(self, input: Option<i32>) -> Self

The minimum size of the group.

Source

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

The minimum size of the group.

Source

pub fn max_size(self, input: i32) -> Self

The maximum size of the group.

This field is required.
Source

pub fn set_max_size(self, input: Option<i32>) -> Self

The maximum size of the group.

Source

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

The maximum size of the group.

Source

pub fn desired_capacity(self, input: i32) -> Self

The desired size of the group.

This field is required.
Source

pub fn set_desired_capacity(self, input: Option<i32>) -> Self

The desired size of the group.

Source

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

The desired size of the group.

Source

pub fn predicted_capacity(self, input: i32) -> Self

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

Source

pub fn set_predicted_capacity(self, input: Option<i32>) -> Self

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

Source

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

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

Source

pub fn default_cooldown(self, input: i32) -> Self

The duration of the default cooldown period, in seconds.

This field is required.
Source

pub fn set_default_cooldown(self, input: Option<i32>) -> Self

The duration of the default cooldown period, in seconds.

Source

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

The duration of the default cooldown period, in seconds.

Source

pub fn availability_zones(self, input: impl Into<String>) -> Self

Appends an item to availability_zones.

To override the contents of this collection use set_availability_zones.

One or more Availability Zones for the group.

Source

pub fn set_availability_zones(self, input: Option<Vec<String>>) -> Self

One or more Availability Zones for the group.

Source

pub fn get_availability_zones(&self) -> &Option<Vec<String>>

One or more Availability Zones for the group.

Source

pub fn load_balancer_names(self, input: impl Into<String>) -> Self

Appends an item to load_balancer_names.

To override the contents of this collection use set_load_balancer_names.

One or more load balancers associated with the group.

Source

pub fn set_load_balancer_names(self, input: Option<Vec<String>>) -> Self

One or more load balancers associated with the group.

Source

pub fn get_load_balancer_names(&self) -> &Option<Vec<String>>

One or more load balancers associated with the group.

Source

pub fn target_group_arns(self, input: impl Into<String>) -> Self

Appends an item to target_group_arns.

To override the contents of this collection use set_target_group_arns.

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

Source

pub fn set_target_group_arns(self, input: Option<Vec<String>>) -> Self

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

Source

pub fn get_target_group_arns(&self) -> &Option<Vec<String>>

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

Source

pub fn health_check_type(self, input: impl Into<String>) -> Self

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

This field is required.
Source

pub fn set_health_check_type(self, input: Option<String>) -> Self

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

Source

pub fn get_health_check_type(&self) -> &Option<String>

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

Source

pub fn health_check_grace_period(self, input: i32) -> Self

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

Source

pub fn set_health_check_grace_period(self, input: Option<i32>) -> Self

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

Source

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

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

Source

pub fn instances(self, input: Instance) -> Self

Appends an item to instances.

To override the contents of this collection use set_instances.

The EC2 instances associated with the group.

Source

pub fn set_instances(self, input: Option<Vec<Instance>>) -> Self

The EC2 instances associated with the group.

Source

pub fn get_instances(&self) -> &Option<Vec<Instance>>

The EC2 instances associated with the group.

Source

pub fn created_time(self, input: DateTime) -> Self

The date and time the group was created.

This field is required.
Source

pub fn set_created_time(self, input: Option<DateTime>) -> Self

The date and time the group was created.

Source

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

The date and time the group was created.

Source

pub fn suspended_processes(self, input: SuspendedProcess) -> Self

Appends an item to suspended_processes.

To override the contents of this collection use set_suspended_processes.

The suspended processes associated with the group.

Source

pub fn set_suspended_processes( self, input: Option<Vec<SuspendedProcess>>, ) -> Self

The suspended processes associated with the group.

Source

pub fn get_suspended_processes(&self) -> &Option<Vec<SuspendedProcess>>

The suspended processes associated with the group.

Source

pub fn placement_group(self, input: impl Into<String>) -> Self

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

Source

pub fn set_placement_group(self, input: Option<String>) -> Self

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

Source

pub fn get_placement_group(&self) -> &Option<String>

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

Source

pub fn vpc_zone_identifier(self, input: impl Into<String>) -> Self

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

Source

pub fn set_vpc_zone_identifier(self, input: Option<String>) -> Self

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

Source

pub fn get_vpc_zone_identifier(&self) -> &Option<String>

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

Source

pub fn enabled_metrics(self, input: EnabledMetric) -> Self

Appends an item to enabled_metrics.

To override the contents of this collection use set_enabled_metrics.

The metrics enabled for the group.

Source

pub fn set_enabled_metrics(self, input: Option<Vec<EnabledMetric>>) -> Self

The metrics enabled for the group.

Source

pub fn get_enabled_metrics(&self) -> &Option<Vec<EnabledMetric>>

The metrics enabled for the group.

Source

pub fn status(self, input: impl Into<String>) -> Self

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

Source

pub fn set_status(self, input: Option<String>) -> Self

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

Source

pub fn get_status(&self) -> &Option<String>

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

Source

pub fn tags(self, input: TagDescription) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

The tags for the group.

Source

pub fn set_tags(self, input: Option<Vec<TagDescription>>) -> Self

The tags for the group.

Source

pub fn get_tags(&self) -> &Option<Vec<TagDescription>>

The tags for the group.

Source

pub fn termination_policies(self, input: impl Into<String>) -> Self

Appends an item to termination_policies.

To override the contents of this collection use set_termination_policies.

The termination policies for the group.

Source

pub fn set_termination_policies(self, input: Option<Vec<String>>) -> Self

The termination policies for the group.

Source

pub fn get_termination_policies(&self) -> &Option<Vec<String>>

The termination policies for the group.

Source

pub fn new_instances_protected_from_scale_in(self, input: bool) -> Self

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 set_new_instances_protected_from_scale_in( self, input: Option<bool>, ) -> Self

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 get_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, input: impl Into<String>) -> Self

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 set_service_linked_role_arn(self, input: Option<String>) -> Self

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 get_service_linked_role_arn(&self) -> &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.

Source

pub fn max_instance_lifetime(self, input: i32) -> Self

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

Valid Range: Minimum value of 0.

Source

pub fn set_max_instance_lifetime(self, input: Option<i32>) -> Self

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

Valid Range: Minimum value of 0.

Source

pub fn get_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, input: bool) -> Self

Indicates whether Capacity Rebalancing is enabled.

Source

pub fn set_capacity_rebalance(self, input: Option<bool>) -> Self

Indicates whether Capacity Rebalancing is enabled.

Source

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

Indicates whether Capacity Rebalancing is enabled.

Source

pub fn warm_pool_configuration(self, input: WarmPoolConfiguration) -> Self

The warm pool for the group.

Source

pub fn set_warm_pool_configuration( self, input: Option<WarmPoolConfiguration>, ) -> Self

The warm pool for the group.

Source

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

The warm pool for the group.

Source

pub fn warm_pool_size(self, input: i32) -> Self

The current size of the warm pool.

Source

pub fn set_warm_pool_size(self, input: Option<i32>) -> Self

The current size of the warm pool.

Source

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

The current size of the warm pool.

Source

pub fn context(self, input: impl Into<String>) -> Self

Reserved.

Source

pub fn set_context(self, input: Option<String>) -> Self

Reserved.

Source

pub fn get_context(&self) -> &Option<String>

Reserved.

Source

pub fn desired_capacity_type(self, input: impl Into<String>) -> Self

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 set_desired_capacity_type(self, input: Option<String>) -> Self

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 get_desired_capacity_type(&self) -> &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.

Source

pub fn default_instance_warmup(self, input: i32) -> Self

The duration of the default instance warmup, in seconds.

Source

pub fn set_default_instance_warmup(self, input: Option<i32>) -> Self

The duration of the default instance warmup, in seconds.

Source

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

The duration of the default instance warmup, in seconds.

Source

pub fn traffic_sources(self, input: TrafficSourceIdentifier) -> Self

Appends an item to traffic_sources.

To override the contents of this collection use set_traffic_sources.

The traffic sources associated with this Auto Scaling group.

Source

pub fn set_traffic_sources( self, input: Option<Vec<TrafficSourceIdentifier>>, ) -> Self

The traffic sources associated with this Auto Scaling group.

Source

pub fn get_traffic_sources(&self) -> &Option<Vec<TrafficSourceIdentifier>>

The traffic sources associated with this Auto Scaling group.

Source

pub fn instance_maintenance_policy( self, input: InstanceMaintenancePolicy, ) -> Self

An instance maintenance policy.

Source

pub fn set_instance_maintenance_policy( self, input: Option<InstanceMaintenancePolicy>, ) -> Self

An instance maintenance policy.

Source

pub fn get_instance_maintenance_policy( &self, ) -> &Option<InstanceMaintenancePolicy>

An instance maintenance policy.

Source

pub fn availability_zone_distribution( self, input: AvailabilityZoneDistribution, ) -> Self

The instance capacity distribution across Availability Zones.

Source

pub fn set_availability_zone_distribution( self, input: Option<AvailabilityZoneDistribution>, ) -> Self

The instance capacity distribution across Availability Zones.

Source

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

The instance capacity distribution across Availability Zones.

Source

pub fn availability_zone_impairment_policy( self, input: AvailabilityZoneImpairmentPolicy, ) -> Self

The Availability Zone impairment policy.

Source

pub fn set_availability_zone_impairment_policy( self, input: Option<AvailabilityZoneImpairmentPolicy>, ) -> Self

The Availability Zone impairment policy.

Source

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

The Availability Zone impairment policy.

Source

pub fn capacity_reservation_specification( self, input: CapacityReservationSpecification, ) -> Self

The capacity reservation specification.

Source

pub fn set_capacity_reservation_specification( self, input: Option<CapacityReservationSpecification>, ) -> Self

The capacity reservation specification.

Source

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

The capacity reservation specification.

Source

pub fn instance_lifecycle_policy(self, input: InstanceLifecyclePolicy) -> Self

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

pub fn set_instance_lifecycle_policy( self, input: Option<InstanceLifecyclePolicy>, ) -> Self

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

pub fn get_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

pub fn build(self) -> AutoScalingGroup

Consumes the builder and constructs a AutoScalingGroup.

Trait Implementations§

Source§

impl Clone for AutoScalingGroupBuilder

Source§

fn clone(&self) -> AutoScalingGroupBuilder

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 AutoScalingGroupBuilder

Source§

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

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

impl Default for AutoScalingGroupBuilder

Source§

fn default() -> AutoScalingGroupBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for AutoScalingGroupBuilder

Source§

fn eq(&self, other: &AutoScalingGroupBuilder) -> 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 AutoScalingGroupBuilder

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