JobBuilder

aws_sdk_iot::types::builders

Struct JobBuilder 

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

A builder for Job.

Implementations§

Source§

impl JobBuilder

Source

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

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Source

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

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Source

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

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

Source

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

The unique identifier you assigned to this job when it was created.

Source

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

The unique identifier you assigned to this job when it was created.

Source

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

The unique identifier you assigned to this job when it was created.

Source

pub fn target_selection(self, input: TargetSelection) -> Self

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

Source

pub fn set_target_selection(self, input: Option<TargetSelection>) -> Self

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

Source

pub fn get_target_selection(&self) -> &Option<TargetSelection>

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

Source

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

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Source

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

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Source

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

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Source

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

Will be true if the job was canceled with the optional force parameter set to true.

Source

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

Will be true if the job was canceled with the optional force parameter set to true.

Source

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

Will be true if the job was canceled with the optional force parameter set to true.

Source

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

If the job was updated, provides the reason code for the update.

Source

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

If the job was updated, provides the reason code for the update.

Source

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

If the job was updated, provides the reason code for the update.

Source

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

If the job was updated, describes the reason for the update.

Source

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

If the job was updated, describes the reason for the update.

Source

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

If the job was updated, describes the reason for the update.

Source

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

Appends an item to targets.

To override the contents of this collection use set_targets.

A list of IoT things and thing groups to which the job should be sent.

Source

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

A list of IoT things and thing groups to which the job should be sent.

Source

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

A list of IoT things and thing groups to which the job should be sent.

Source

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

A short text description of the job.

Source

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

A short text description of the job.

Source

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

A short text description of the job.

Source

pub fn presigned_url_config(self, input: PresignedUrlConfig) -> Self

Configuration for pre-signed S3 URLs.

Source

pub fn set_presigned_url_config(self, input: Option<PresignedUrlConfig>) -> Self

Configuration for pre-signed S3 URLs.

Source

pub fn get_presigned_url_config(&self) -> &Option<PresignedUrlConfig>

Configuration for pre-signed S3 URLs.

Source

pub fn job_executions_rollout_config( self, input: JobExecutionsRolloutConfig, ) -> Self

Allows you to create a staged rollout of a job.

Source

pub fn set_job_executions_rollout_config( self, input: Option<JobExecutionsRolloutConfig>, ) -> Self

Allows you to create a staged rollout of a job.

Source

pub fn get_job_executions_rollout_config( &self, ) -> &Option<JobExecutionsRolloutConfig>

Allows you to create a staged rollout of a job.

Source

pub fn abort_config(self, input: AbortConfig) -> Self

Configuration for criteria to abort the job.

Source

pub fn set_abort_config(self, input: Option<AbortConfig>) -> Self

Configuration for criteria to abort the job.

Source

pub fn get_abort_config(&self) -> &Option<AbortConfig>

Configuration for criteria to abort the job.

Source

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

The time, in seconds since the epoch, when the job was created.

Source

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

The time, in seconds since the epoch, when the job was created.

Source

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

The time, in seconds since the epoch, when the job was created.

Source

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

The time, in seconds since the epoch, when the job was last updated.

Source

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

The time, in seconds since the epoch, when the job was last updated.

Source

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

The time, in seconds since the epoch, when the job was last updated.

Source

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

The time, in seconds since the epoch, when the job was completed.

Source

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

The time, in seconds since the epoch, when the job was completed.

Source

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

The time, in seconds since the epoch, when the job was completed.

Source

pub fn job_process_details(self, input: JobProcessDetails) -> Self

Details about the job process.

Source

pub fn set_job_process_details(self, input: Option<JobProcessDetails>) -> Self

Details about the job process.

Source

pub fn get_job_process_details(&self) -> &Option<JobProcessDetails>

Details about the job process.

Source

pub fn timeout_config(self, input: TimeoutConfig) -> Self

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Source

pub fn set_timeout_config(self, input: Option<TimeoutConfig>) -> Self

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Source

pub fn get_timeout_config(&self) -> &Option<TimeoutConfig>

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

Source

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

Source

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

Source

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

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

Source

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

The ARN of the job template used to create the job.

Source

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

The ARN of the job template used to create the job.

Source

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

The ARN of the job template used to create the job.

Source

pub fn job_executions_retry_config( self, input: JobExecutionsRetryConfig, ) -> Self

The configuration for the criteria to retry the job.

Source

pub fn set_job_executions_retry_config( self, input: Option<JobExecutionsRetryConfig>, ) -> Self

The configuration for the criteria to retry the job.

Source

pub fn get_job_executions_retry_config( &self, ) -> &Option<JobExecutionsRetryConfig>

The configuration for the criteria to retry the job.

Source

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

Adds a key-value pair to document_parameters.

To override the contents of this collection use set_document_parameters.

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

Source

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

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

Source

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

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

Source

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

Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

Source

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

Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

Source

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

Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

Source

pub fn scheduling_config(self, input: SchedulingConfig) -> Self

The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.

Source

pub fn set_scheduling_config(self, input: Option<SchedulingConfig>) -> Self

The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.

Source

pub fn get_scheduling_config(&self) -> &Option<SchedulingConfig>

The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.

Source

pub fn scheduled_job_rollouts(self, input: ScheduledJobRollout) -> Self

Appends an item to scheduled_job_rollouts.

To override the contents of this collection use set_scheduled_job_rollouts.

Displays the next seven maintenance window occurrences and their start times.

Source

pub fn set_scheduled_job_rollouts( self, input: Option<Vec<ScheduledJobRollout>>, ) -> Self

Displays the next seven maintenance window occurrences and their start times.

Source

pub fn get_scheduled_job_rollouts(&self) -> &Option<Vec<ScheduledJobRollout>>

Displays the next seven maintenance window occurrences and their start times.

Source

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

Appends an item to destination_package_versions.

To override the contents of this collection use set_destination_package_versions.

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Source

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

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Source

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

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Source

pub fn build(self) -> Job

Consumes the builder and constructs a Job.

Trait Implementations§

Source§

impl Clone for JobBuilder

Source§

fn clone(&self) -> JobBuilder

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 JobBuilder

Source§

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

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

impl Default for JobBuilder

Source§

fn default() -> JobBuilder

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

impl PartialEq for JobBuilder

Source§

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

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,