Struct Client

Source
pub struct Client { /* private fields */ }
Expand description

Client for Auto Scaling

Client for invoking operations on Auto Scaling. Each operation on Auto Scaling is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_autoscaling::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_autoscaling::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

§Using the Client

A client has a function for every operation that can be performed by the service. For example, the AttachInstances operation has a Client::attach_instances, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.attach_instances()
    .auto_scaling_group_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations§

Source§

impl Client

Source

pub fn attach_instances(&self) -> AttachInstancesFluentBuilder

Constructs a fluent builder for the AttachInstances operation.

Source§

impl Client

Source

pub fn attach_load_balancer_target_groups( &self, ) -> AttachLoadBalancerTargetGroupsFluentBuilder

Constructs a fluent builder for the AttachLoadBalancerTargetGroups operation.

Source§

impl Client

Source

pub fn attach_load_balancers(&self) -> AttachLoadBalancersFluentBuilder

Constructs a fluent builder for the AttachLoadBalancers operation.

Source§

impl Client

Source

pub fn attach_traffic_sources(&self) -> AttachTrafficSourcesFluentBuilder

Constructs a fluent builder for the AttachTrafficSources operation.

Source§

impl Client

Source

pub fn batch_delete_scheduled_action( &self, ) -> BatchDeleteScheduledActionFluentBuilder

Constructs a fluent builder for the BatchDeleteScheduledAction operation.

Source§

impl Client

Source

pub fn batch_put_scheduled_update_group_action( &self, ) -> BatchPutScheduledUpdateGroupActionFluentBuilder

Constructs a fluent builder for the BatchPutScheduledUpdateGroupAction operation.

Source§

impl Client

Source

pub fn cancel_instance_refresh(&self) -> CancelInstanceRefreshFluentBuilder

Constructs a fluent builder for the CancelInstanceRefresh operation.

Source§

impl Client

Source

pub fn complete_lifecycle_action(&self) -> CompleteLifecycleActionFluentBuilder

Constructs a fluent builder for the CompleteLifecycleAction operation.

Source§

impl Client

Source

pub fn create_auto_scaling_group(&self) -> CreateAutoScalingGroupFluentBuilder

Constructs a fluent builder for the CreateAutoScalingGroup operation.

Source§

impl Client

Source

pub fn create_launch_configuration( &self, ) -> CreateLaunchConfigurationFluentBuilder

Constructs a fluent builder for the CreateLaunchConfiguration operation.

Source§

impl Client

Source

pub fn create_or_update_tags(&self) -> CreateOrUpdateTagsFluentBuilder

Constructs a fluent builder for the CreateOrUpdateTags operation.

Source§

impl Client

Source

pub fn delete_auto_scaling_group(&self) -> DeleteAutoScalingGroupFluentBuilder

Constructs a fluent builder for the DeleteAutoScalingGroup operation.

Source§

impl Client

Source

pub fn delete_launch_configuration( &self, ) -> DeleteLaunchConfigurationFluentBuilder

Constructs a fluent builder for the DeleteLaunchConfiguration operation.

Source§

impl Client

Source

pub fn delete_lifecycle_hook(&self) -> DeleteLifecycleHookFluentBuilder

Constructs a fluent builder for the DeleteLifecycleHook operation.

Source§

impl Client

Source

pub fn delete_notification_configuration( &self, ) -> DeleteNotificationConfigurationFluentBuilder

Constructs a fluent builder for the DeleteNotificationConfiguration operation.

Source§

impl Client

Source

pub fn delete_policy(&self) -> DeletePolicyFluentBuilder

Constructs a fluent builder for the DeletePolicy operation.

Source§

impl Client

Source

pub fn delete_scheduled_action(&self) -> DeleteScheduledActionFluentBuilder

Constructs a fluent builder for the DeleteScheduledAction operation.

Source§

impl Client

Source

pub fn delete_tags(&self) -> DeleteTagsFluentBuilder

Constructs a fluent builder for the DeleteTags operation.

Source§

impl Client

Source

pub fn delete_warm_pool(&self) -> DeleteWarmPoolFluentBuilder

Constructs a fluent builder for the DeleteWarmPool operation.

Source§

impl Client

Source

pub fn describe_account_limits(&self) -> DescribeAccountLimitsFluentBuilder

Constructs a fluent builder for the DescribeAccountLimits operation.

Source§

impl Client

Source

pub fn describe_adjustment_types(&self) -> DescribeAdjustmentTypesFluentBuilder

Constructs a fluent builder for the DescribeAdjustmentTypes operation.

Source§

impl Client

Source

pub fn describe_auto_scaling_groups( &self, ) -> DescribeAutoScalingGroupsFluentBuilder

Constructs a fluent builder for the DescribeAutoScalingGroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_auto_scaling_instances( &self, ) -> DescribeAutoScalingInstancesFluentBuilder

Constructs a fluent builder for the DescribeAutoScalingInstances operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_auto_scaling_notification_types( &self, ) -> DescribeAutoScalingNotificationTypesFluentBuilder

Constructs a fluent builder for the DescribeAutoScalingNotificationTypes operation.

Source§

impl Client

Source

pub fn describe_instance_refreshes( &self, ) -> DescribeInstanceRefreshesFluentBuilder

Constructs a fluent builder for the DescribeInstanceRefreshes operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_launch_configurations( &self, ) -> DescribeLaunchConfigurationsFluentBuilder

Constructs a fluent builder for the DescribeLaunchConfigurations operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_lifecycle_hook_types( &self, ) -> DescribeLifecycleHookTypesFluentBuilder

Constructs a fluent builder for the DescribeLifecycleHookTypes operation.

Source§

impl Client

Source

pub fn describe_lifecycle_hooks(&self) -> DescribeLifecycleHooksFluentBuilder

Constructs a fluent builder for the DescribeLifecycleHooks operation.

Source§

impl Client

Source

pub fn describe_load_balancer_target_groups( &self, ) -> DescribeLoadBalancerTargetGroupsFluentBuilder

Constructs a fluent builder for the DescribeLoadBalancerTargetGroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_load_balancers(&self) -> DescribeLoadBalancersFluentBuilder

Constructs a fluent builder for the DescribeLoadBalancers operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_metric_collection_types( &self, ) -> DescribeMetricCollectionTypesFluentBuilder

Constructs a fluent builder for the DescribeMetricCollectionTypes operation.

Source§

impl Client

Source

pub fn describe_notification_configurations( &self, ) -> DescribeNotificationConfigurationsFluentBuilder

Constructs a fluent builder for the DescribeNotificationConfigurations operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_policies(&self) -> DescribePoliciesFluentBuilder

Constructs a fluent builder for the DescribePolicies operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_scaling_activities( &self, ) -> DescribeScalingActivitiesFluentBuilder

Constructs a fluent builder for the DescribeScalingActivities operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_scaling_process_types( &self, ) -> DescribeScalingProcessTypesFluentBuilder

Constructs a fluent builder for the DescribeScalingProcessTypes operation.

Source§

impl Client

Source

pub fn describe_scheduled_actions( &self, ) -> DescribeScheduledActionsFluentBuilder

Constructs a fluent builder for the DescribeScheduledActions operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_tags(&self) -> DescribeTagsFluentBuilder

Constructs a fluent builder for the DescribeTags operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_termination_policy_types( &self, ) -> DescribeTerminationPolicyTypesFluentBuilder

Constructs a fluent builder for the DescribeTerminationPolicyTypes operation.

Source§

impl Client

Source

pub fn describe_traffic_sources(&self) -> DescribeTrafficSourcesFluentBuilder

Constructs a fluent builder for the DescribeTrafficSources operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_warm_pool(&self) -> DescribeWarmPoolFluentBuilder

Constructs a fluent builder for the DescribeWarmPool operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn detach_instances(&self) -> DetachInstancesFluentBuilder

Constructs a fluent builder for the DetachInstances operation.

Source§

impl Client

Source

pub fn detach_load_balancer_target_groups( &self, ) -> DetachLoadBalancerTargetGroupsFluentBuilder

Constructs a fluent builder for the DetachLoadBalancerTargetGroups operation.

Source§

impl Client

Source

pub fn detach_load_balancers(&self) -> DetachLoadBalancersFluentBuilder

Constructs a fluent builder for the DetachLoadBalancers operation.

Source§

impl Client

Source

pub fn detach_traffic_sources(&self) -> DetachTrafficSourcesFluentBuilder

Constructs a fluent builder for the DetachTrafficSources operation.

Source§

impl Client

Source

pub fn disable_metrics_collection( &self, ) -> DisableMetricsCollectionFluentBuilder

Constructs a fluent builder for the DisableMetricsCollection operation.

Source§

impl Client

Source

pub fn enable_metrics_collection(&self) -> EnableMetricsCollectionFluentBuilder

Constructs a fluent builder for the EnableMetricsCollection operation.

Source§

impl Client

Source

pub fn enter_standby(&self) -> EnterStandbyFluentBuilder

Constructs a fluent builder for the EnterStandby operation.

Source§

impl Client

Source

pub fn execute_policy(&self) -> ExecutePolicyFluentBuilder

Constructs a fluent builder for the ExecutePolicy operation.

Source§

impl Client

Source

pub fn exit_standby(&self) -> ExitStandbyFluentBuilder

Constructs a fluent builder for the ExitStandby operation.

Source§

impl Client

Source

pub fn get_predictive_scaling_forecast( &self, ) -> GetPredictiveScalingForecastFluentBuilder

Constructs a fluent builder for the GetPredictiveScalingForecast operation.

Source§

impl Client

Source

pub fn put_lifecycle_hook(&self) -> PutLifecycleHookFluentBuilder

Constructs a fluent builder for the PutLifecycleHook operation.

Source§

impl Client

Source

pub fn put_notification_configuration( &self, ) -> PutNotificationConfigurationFluentBuilder

Constructs a fluent builder for the PutNotificationConfiguration operation.

Source§

impl Client

Source

pub fn put_scaling_policy(&self) -> PutScalingPolicyFluentBuilder

Constructs a fluent builder for the PutScalingPolicy operation.

Source§

impl Client

Source

pub fn put_scheduled_update_group_action( &self, ) -> PutScheduledUpdateGroupActionFluentBuilder

Constructs a fluent builder for the PutScheduledUpdateGroupAction operation.

Source§

impl Client

Source

pub fn put_warm_pool(&self) -> PutWarmPoolFluentBuilder

Constructs a fluent builder for the PutWarmPool operation.

  • The fluent builder is configurable:
    • auto_scaling_group_name(impl Into<String>) / set_auto_scaling_group_name(Option<String>):
      required: true

      The name of the Auto Scaling group.


    • max_group_prepared_capacity(i32) / set_max_group_prepared_capacity(Option<i32>):
      required: false

      Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group’s maximum capacity and its desired capacity.

      If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group’s maximum capacity and its desired capacity. If you specify a value for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

      The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute size.

      If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless you specify a value for MinSize. To remove a value that you previously set, include the property but specify -1 for the value.


    • min_size(i32) / set_min_size(Option<i32>):
      required: false

      Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.


    • pool_state(WarmPoolState) / set_pool_state(Option<WarmPoolState>):
      required: false

      Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped.


    • instance_reuse_policy(InstanceReusePolicy) / set_instance_reuse_policy(Option<InstanceReusePolicy>):
      required: false

      Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.


  • On success, responds with PutWarmPoolOutput
  • On failure, responds with SdkError<PutWarmPoolError>
Source§

impl Client

Source

pub fn record_lifecycle_action_heartbeat( &self, ) -> RecordLifecycleActionHeartbeatFluentBuilder

Constructs a fluent builder for the RecordLifecycleActionHeartbeat operation.

Source§

impl Client

Source

pub fn resume_processes(&self) -> ResumeProcessesFluentBuilder

Constructs a fluent builder for the ResumeProcesses operation.

Source§

impl Client

Source

pub fn rollback_instance_refresh(&self) -> RollbackInstanceRefreshFluentBuilder

Constructs a fluent builder for the RollbackInstanceRefresh operation.

Source§

impl Client

Source

pub fn set_desired_capacity(&self) -> SetDesiredCapacityFluentBuilder

Constructs a fluent builder for the SetDesiredCapacity operation.

Source§

impl Client

Source

pub fn set_instance_health(&self) -> SetInstanceHealthFluentBuilder

Constructs a fluent builder for the SetInstanceHealth operation.

Source§

impl Client

Source

pub fn set_instance_protection(&self) -> SetInstanceProtectionFluentBuilder

Constructs a fluent builder for the SetInstanceProtection operation.

Source§

impl Client

Source

pub fn start_instance_refresh(&self) -> StartInstanceRefreshFluentBuilder

Constructs a fluent builder for the StartInstanceRefresh operation.

Source§

impl Client

Source

pub fn suspend_processes(&self) -> SuspendProcessesFluentBuilder

Constructs a fluent builder for the SuspendProcesses operation.

Source§

impl Client

Source

pub fn terminate_instance_in_auto_scaling_group( &self, ) -> TerminateInstanceInAutoScalingGroupFluentBuilder

Constructs a fluent builder for the TerminateInstanceInAutoScalingGroup operation.

Source§

impl Client

Source

pub fn update_auto_scaling_group(&self) -> UpdateAutoScalingGroupFluentBuilder

Constructs a fluent builder for the UpdateAutoScalingGroup operation.

Source§

impl Client

Source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

  • Retries or timeouts are enabled without a sleep_impl configured.
  • Identity caching is enabled without a sleep_impl and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

Source

pub fn config(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
  • This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

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 Client

Source§

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

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

impl Waiters for Client

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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

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