aws_sdk_ssm::types::builders

Struct AutomationExecutionBuilder

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

A builder for AutomationExecution.

Implementations§

Source§

impl AutomationExecutionBuilder

Source

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

The execution ID.

Source

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

The execution ID.

Source

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

The execution ID.

Source

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

The name of the Automation runbook used during the execution.

Source

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

The name of the Automation runbook used during the execution.

Source

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

The name of the Automation runbook used during the execution.

Source

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

The version of the document to use during execution.

Source

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

The version of the document to use during execution.

Source

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

The version of the document to use during execution.

Source

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

The time the execution started.

Source

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

The time the execution started.

Source

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

The time the execution started.

Source

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

The time the execution finished.

Source

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

The time the execution finished.

Source

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

The time the execution finished.

Source

pub fn automation_execution_status( self, input: AutomationExecutionStatus, ) -> Self

The execution status of the Automation.

Source

pub fn set_automation_execution_status( self, input: Option<AutomationExecutionStatus>, ) -> Self

The execution status of the Automation.

Source

pub fn get_automation_execution_status( &self, ) -> &Option<AutomationExecutionStatus>

The execution status of the Automation.

Source

pub fn step_executions(self, input: StepExecution) -> Self

Appends an item to step_executions.

To override the contents of this collection use set_step_executions.

A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.

Source

pub fn set_step_executions(self, input: Option<Vec<StepExecution>>) -> Self

A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.

Source

pub fn get_step_executions(&self) -> &Option<Vec<StepExecution>>

A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.

Source

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

A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.

Source

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

A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.

Source

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

A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.

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.

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

Source

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

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

Source

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

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

Source

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

Adds a key-value pair to outputs.

To override the contents of this collection use set_outputs.

The list of execution outputs as defined in the Automation runbook.

Source

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

The list of execution outputs as defined in the Automation runbook.

Source

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

The list of execution outputs as defined in the Automation runbook.

Source

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

A message describing why an execution has failed, if the status is set to Failed.

Source

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

A message describing why an execution has failed, if the status is set to Failed.

Source

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

A message describing why an execution has failed, if the status is set to Failed.

Source

pub fn mode(self, input: ExecutionMode) -> Self

The automation execution mode.

Source

pub fn set_mode(self, input: Option<ExecutionMode>) -> Self

The automation execution mode.

Source

pub fn get_mode(&self) -> &Option<ExecutionMode>

The automation execution mode.

Source

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

The AutomationExecutionId of the parent automation.

Source

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

The AutomationExecutionId of the parent automation.

Source

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

The AutomationExecutionId of the parent automation.

Source

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

The Amazon Resource Name (ARN) of the user who ran the automation.

Source

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

The Amazon Resource Name (ARN) of the user who ran the automation.

Source

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

The Amazon Resource Name (ARN) of the user who ran the automation.

Source

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

The name of the step that is currently running.

Source

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

The name of the step that is currently running.

Source

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

The name of the step that is currently running.

Source

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

The action of the step that is currently running.

Source

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

The action of the step that is currently running.

Source

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

The action of the step that is currently running.

Source

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

The parameter name.

Source

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

The parameter name.

Source

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

The parameter name.

Source

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

Appends an item to targets.

To override the contents of this collection use set_targets.

The specified targets.

Source

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

The specified targets.

Source

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

The specified 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.

The specified key-value mapping of document parameters to target resources.

Source

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

The specified key-value mapping of document parameters to target resources.

Source

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

The specified key-value mapping of document parameters to target resources.

Source

pub fn resolved_targets(self, input: ResolvedTargets) -> Self

A list of resolved targets in the rate control execution.

Source

pub fn set_resolved_targets(self, input: Option<ResolvedTargets>) -> Self

A list of resolved targets in the rate control execution.

Source

pub fn get_resolved_targets(&self) -> &Option<ResolvedTargets>

A list of resolved targets in the rate control execution.

Source

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

The MaxConcurrency value specified by the user when the execution started.

Source

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

The MaxConcurrency value specified by the user when the execution started.

Source

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

The MaxConcurrency value specified by the user when the execution started.

Source

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

The MaxErrors value specified by the user when the execution started.

Source

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

The MaxErrors value specified by the user when the execution started.

Source

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

The MaxErrors value specified by the user when the execution started.

Source

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

The target of the execution.

Source

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

The target of the execution.

Source

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

The target of the execution.

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/or Amazon Web Services accounts where you want to run the Automation.

Source

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

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

Source

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

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

Source

pub fn progress_counters(self, input: ProgressCounters) -> Self

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

Source

pub fn set_progress_counters(self, input: Option<ProgressCounters>) -> Self

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

Source

pub fn get_progress_counters(&self) -> &Option<ProgressCounters>

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

Source

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

The details for the CloudWatch alarm applied to your automation.

Source

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

The details for the CloudWatch alarm applied to your automation.

Source

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

The details for the CloudWatch alarm applied to your automation.

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 by the automation.

Source

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

The CloudWatch alarm that was invoked by the automation.

Source

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

The CloudWatch alarm that was invoked by the automation.

Source

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

A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported

Source

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

A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported

Source

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

A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported

Source

pub fn automation_subtype(self, input: AutomationSubtype) -> Self

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

Source

pub fn set_automation_subtype(self, input: Option<AutomationSubtype>) -> Self

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

Source

pub fn get_automation_subtype(&self) -> &Option<AutomationSubtype>

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

Source

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

The date and time the Automation operation is scheduled to start.

Source

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

The date and time the Automation operation is scheduled to start.

Source

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

The date and time the Automation operation is scheduled to start.

Source

pub fn runbooks(self, input: Runbook) -> Self

Appends an item to runbooks.

To override the contents of this collection use set_runbooks.

Information about the Automation runbooks that are run as part of a runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Source

pub fn set_runbooks(self, input: Option<Vec<Runbook>>) -> Self

Information about the Automation runbooks that are run as part of a runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Source

pub fn get_runbooks(&self) -> &Option<Vec<Runbook>>

Information about the Automation runbooks that are run as part of a runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Source

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

The ID of an OpsItem that is created to represent a Change Manager change request.

Source

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

The ID of an OpsItem that is created to represent a Change Manager change request.

Source

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

The ID of an OpsItem that is created to represent a Change Manager change request.

Source

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

The ID of a State Manager association used in the Automation operation.

Source

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

The ID of a State Manager association used in the Automation operation.

Source

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

The ID of a State Manager association used in the Automation operation.

Source

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

The name of the Change Manager change request.

Source

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

The name of the Change Manager change request.

Source

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

The name of the Change Manager change request.

Source

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

Adds a key-value pair to variables.

To override the contents of this collection use set_variables.

Variables defined for the automation.

Source

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

Variables defined for the automation.

Source

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

Variables defined for the automation.

Source

pub fn build(self) -> AutomationExecution

Consumes the builder and constructs a AutomationExecution.

Trait Implementations§

Source§

impl Clone for AutomationExecutionBuilder

Source§

fn clone(&self) -> AutomationExecutionBuilder

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 AutomationExecutionBuilder

Source§

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

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

impl Default for AutomationExecutionBuilder

Source§

fn default() -> AutomationExecutionBuilder

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

impl PartialEq for AutomationExecutionBuilder

Source§

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

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,