AssociationDescriptionBuilder

aws_sdk_ssm::types::builders

Struct AssociationDescriptionBuilder 

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

A builder for AssociationDescription.

Implementations§

Source§

impl AssociationDescriptionBuilder

Source

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

The name of the SSM document.

Source

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

The name of the SSM document.

Source

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

The name of the SSM document.

Source

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

The managed node ID.

Source

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

The managed node ID.

Source

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

The managed node ID.

Source

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

The association version.

Source

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

The association version.

Source

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

The association version.

Source

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

The date when the association was made.

Source

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

The date when the association was made.

Source

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

The date when the association was made.

Source

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

The date when the association was last updated.

Source

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

The date when the association was last updated.

Source

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

The date when the association was last updated.

Source

pub fn status(self, input: AssociationStatus) -> Self

The association status.

Source

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

The association status.

Source

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

The association status.

Source

pub fn overview(self, input: AssociationOverview) -> Self

Information about the association.

Source

pub fn set_overview(self, input: Option<AssociationOverview>) -> Self

Information about the association.

Source

pub fn get_overview(&self) -> &Option<AssociationOverview>

Information about the association.

Source

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

The document version.

Source

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

The document version.

Source

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

The document version.

Source

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

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.

Source

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

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.

Source

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

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.

Source

pub fn parameters(self, k: impl Into<String>, v: Vec<String>) -> Self

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

A description of the parameters for a document.

Source

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

A description of the parameters for a document.

Source

pub fn get_parameters(&self) -> &Option<HashMap<String, Vec<String>>>

A description of the parameters for a document.

Source

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

The association ID.

Source

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

The association ID.

Source

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

The association ID.

Source

pub fn targets(self, input: Target) -> Self

Appends an item to targets.

To override the contents of this collection use set_targets.

The managed nodes targeted by the request.

Source

pub fn set_targets(self, input: Option<Vec<Target>>) -> Self

The managed nodes targeted by the request.

Source

pub fn get_targets(&self) -> &Option<Vec<Target>>

The managed nodes targeted by the request.

Source

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

A cron expression that specifies a schedule when the association runs.

Source

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

A cron expression that specifies a schedule when the association runs.

Source

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

A cron expression that specifies a schedule when the association runs.

Source

pub fn output_location(self, input: InstanceAssociationOutputLocation) -> Self

An S3 bucket where you want to store the output details of the request.

Source

pub fn set_output_location( self, input: Option<InstanceAssociationOutputLocation>, ) -> Self

An S3 bucket where you want to store the output details of the request.

Source

pub fn get_output_location(&self) -> &Option<InstanceAssociationOutputLocation>

An S3 bucket where you want to store the output details of the request.

Source

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

The date on which the association was last run.

Source

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

The date on which the association was last run.

Source

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

The date on which the association was last run.

Source

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

The last date on which the association was successfully run.

Source

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

The last date on which the association was successfully run.

Source

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

The last date on which the association was successfully run.

Source

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

The association name.

Source

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

The association name.

Source

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

The association name.

Source

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

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

Source

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

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

Source

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

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

Source

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

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

Source

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

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

Source

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

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

Source

pub fn compliance_severity(self, input: AssociationComplianceSeverity) -> Self

The severity level that is assigned to the association.

Source

pub fn set_compliance_severity( self, input: Option<AssociationComplianceSeverity>, ) -> Self

The severity level that is assigned to the association.

Source

pub fn get_compliance_severity(&self) -> &Option<AssociationComplianceSeverity>

The severity level that is assigned to the association.

Source

pub fn sync_compliance(self, input: AssociationSyncCompliance) -> Self

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

Source

pub fn set_sync_compliance( self, input: Option<AssociationSyncCompliance>, ) -> Self

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

Source

pub fn get_sync_compliance(&self) -> &Option<AssociationSyncCompliance>

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

Source

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

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

Source

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

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

Source

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

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

Source

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

Appends an item to calendar_names.

To override the contents of this collection use set_calendar_names.

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

Source

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

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

Source

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

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

Source

pub fn target_locations(self, input: TargetLocation) -> Self

Appends an item to target_locations.

To override the contents of this collection use set_target_locations.

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

Source

pub fn set_target_locations(self, input: Option<Vec<TargetLocation>>) -> Self

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

Source

pub fn get_target_locations(&self) -> &Option<Vec<TargetLocation>>

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

Source

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

Number of days to wait after the scheduled day to run an association.

Source

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

Number of days to wait after the scheduled day to run an association.

Source

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

Number of days to wait after the scheduled day to run an association.

Source

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

The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

Source

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

The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

Source

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

The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.

Source

pub fn target_maps(self, input: HashMap<String, Vec<String>>) -> Self

Appends an item to target_maps.

To override the contents of this collection use set_target_maps.

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Source

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

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Source

pub fn get_target_maps(&self) -> &Option<Vec<HashMap<String, Vec<String>>>>

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Source

pub fn alarm_configuration(self, input: AlarmConfiguration) -> Self

The details for the CloudWatch alarm you want to apply to an automation or command.

Source

pub fn set_alarm_configuration(self, input: Option<AlarmConfiguration>) -> Self

The details for the CloudWatch alarm you want to apply to an automation or command.

Source

pub fn get_alarm_configuration(&self) -> &Option<AlarmConfiguration>

The details for the CloudWatch alarm you want to apply to an automation or command.

Source

pub fn triggered_alarms(self, input: AlarmStateInformation) -> Self

Appends an item to triggered_alarms.

To override the contents of this collection use set_triggered_alarms.

The CloudWatch alarm that was invoked during the association.

Source

pub fn set_triggered_alarms( self, input: Option<Vec<AlarmStateInformation>>, ) -> Self

The CloudWatch alarm that was invoked during the association.

Source

pub fn get_triggered_alarms(&self) -> &Option<Vec<AlarmStateInformation>>

The CloudWatch alarm that was invoked during the association.

Source

pub fn build(self) -> AssociationDescription

Consumes the builder and constructs a AssociationDescription.

Trait Implementations§

Source§

impl Clone for AssociationDescriptionBuilder

Source§

fn clone(&self) -> AssociationDescriptionBuilder

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 AssociationDescriptionBuilder

Source§

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

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

impl Default for AssociationDescriptionBuilder

Source§

fn default() -> AssociationDescriptionBuilder

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

impl PartialEq for AssociationDescriptionBuilder

Source§

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

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

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