JobDetailBuilder

aws_sdk_batch::types::builders

Struct JobDetailBuilder 

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

A builder for JobDetail.

Implementations§

Source§

impl JobDetailBuilder

Source

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

The Amazon Resource Name (ARN) of the job.

Source

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

The Amazon Resource Name (ARN) of the job.

Source

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

The Amazon Resource Name (ARN) of the job.

Source

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

The job name.

This field is required.
Source

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

The job name.

Source

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

The job name.

Source

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

The job ID.

This field is required.
Source

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

The job ID.

Source

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

The job ID.

Source

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

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

This field is required.
Source

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

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

Source

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

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

Source

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

The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

 This field is required.
Source

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

The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

Source

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

The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

Source

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

The share identifier for the job.

Source

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

The share identifier for the job.

Source

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

The share identifier for the job.

Source

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

The scheduling policy of the job definition. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

Source

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

The scheduling policy of the job definition. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

Source

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

The scheduling policy of the job definition. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

Source

pub fn attempts(self, input: AttemptDetail) -> Self

Appends an item to attempts.

To override the contents of this collection use set_attempts.

A list of job attempts that are associated with this job.

Source

pub fn set_attempts(self, input: Option<Vec<AttemptDetail>>) -> Self

A list of job attempts that are associated with this job.

Source

pub fn get_attempts(&self) -> &Option<Vec<AttemptDetail>>

A list of job attempts that are associated with this job.

Source

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

A short, human-readable string to provide more details for the current status of the job.

  • CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have insufficient capacity to service the job.

  • MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments have a maxVcpu setting that is smaller than the job requirements.

  • MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no connected instances that meet the job requirements.

  • MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have problems with the service role permissions.

Source

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

A short, human-readable string to provide more details for the current status of the job.

  • CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have insufficient capacity to service the job.

  • MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments have a maxVcpu setting that is smaller than the job requirements.

  • MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no connected instances that meet the job requirements.

  • MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have problems with the service role permissions.

Source

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

A short, human-readable string to provide more details for the current status of the job.

  • CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have insufficient capacity to service the job.

  • MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments have a maxVcpu setting that is smaller than the job requirements.

  • MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no connected instances that meet the job requirements.

  • MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have problems with the service role permissions.

Source

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

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

Source

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

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

Source

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

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

Source

pub fn retry_strategy(self, input: RetryStrategy) -> Self

The retry strategy to use for this job if an attempt fails.

Source

pub fn set_retry_strategy(self, input: Option<RetryStrategy>) -> Self

The retry strategy to use for this job if an attempt fails.

Source

pub fn get_retry_strategy(&self) -> &Option<RetryStrategy>

The retry strategy to use for this job if an attempt fails.

Source

pub fn started_at(self, input: i64) -> Self

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

This field is required.
Source

pub fn set_started_at(self, input: Option<i64>) -> Self

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

Source

pub fn get_started_at(&self) -> &Option<i64>

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

Source

pub fn stopped_at(self, input: i64) -> Self

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

Source

pub fn set_stopped_at(self, input: Option<i64>) -> Self

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

Source

pub fn get_stopped_at(&self) -> &Option<i64>

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

Source

pub fn depends_on(self, input: JobDependency) -> Self

Appends an item to depends_on.

To override the contents of this collection use set_depends_on.

A list of job IDs that this job depends on.

Source

pub fn set_depends_on(self, input: Option<Vec<JobDependency>>) -> Self

A list of job IDs that this job depends on.

Source

pub fn get_depends_on(&self) -> &Option<Vec<JobDependency>>

A list of job IDs that this job depends on.

Source

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

The Amazon Resource Name (ARN) of the job definition that this job uses.

This field is required.
Source

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

The Amazon Resource Name (ARN) of the job definition that this job uses.

Source

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

The Amazon Resource Name (ARN) of the job definition that this job uses.

Source

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

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

Source

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

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

Source

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

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

Source

pub fn container(self, input: ContainerDetail) -> Self

An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.

Source

pub fn set_container(self, input: Option<ContainerDetail>) -> Self

An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.

Source

pub fn get_container(&self) -> &Option<ContainerDetail>

An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.

Source

pub fn node_details(self, input: NodeDetails) -> Self

An object that represents the details of a node that's associated with a multi-node parallel job.

Source

pub fn set_node_details(self, input: Option<NodeDetails>) -> Self

An object that represents the details of a node that's associated with a multi-node parallel job.

Source

pub fn get_node_details(&self) -> &Option<NodeDetails>

An object that represents the details of a node that's associated with a multi-node parallel job.

Source

pub fn node_properties(self, input: NodeProperties) -> Self

An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

Source

pub fn set_node_properties(self, input: Option<NodeProperties>) -> Self

An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

Source

pub fn get_node_properties(&self) -> &Option<NodeProperties>

An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

Source

pub fn array_properties(self, input: ArrayPropertiesDetail) -> Self

The array properties of the job, if it's an array job.

Source

pub fn set_array_properties(self, input: Option<ArrayPropertiesDetail>) -> Self

The array properties of the job, if it's an array job.

Source

pub fn get_array_properties(&self) -> &Option<ArrayPropertiesDetail>

The array properties of the job, if it's an array job.

Source

pub fn timeout(self, input: JobTimeout) -> Self

The timeout configuration for the job.

Source

pub fn set_timeout(self, input: Option<JobTimeout>) -> Self

The timeout configuration for the job.

Source

pub fn get_timeout(&self) -> &Option<JobTimeout>

The timeout configuration for the job.

Source

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

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The tags that are applied to the job.

Source

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

The tags that are applied to the job.

Source

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

The tags that are applied to the job.

Source

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

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Source

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

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Source

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

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Source

pub fn platform_capabilities(self, input: PlatformCapability) -> Self

Appends an item to platform_capabilities.

To override the contents of this collection use set_platform_capabilities.

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Source

pub fn set_platform_capabilities( self, input: Option<Vec<PlatformCapability>>, ) -> Self

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Source

pub fn get_platform_capabilities(&self) -> &Option<Vec<PlatformCapability>>

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Source

pub fn eks_properties(self, input: EksPropertiesDetail) -> Self

An object with various properties that are specific to Amazon EKS based jobs.

Source

pub fn set_eks_properties(self, input: Option<EksPropertiesDetail>) -> Self

An object with various properties that are specific to Amazon EKS based jobs.

Source

pub fn get_eks_properties(&self) -> &Option<EksPropertiesDetail>

An object with various properties that are specific to Amazon EKS based jobs.

Source

pub fn eks_attempts(self, input: EksAttemptDetail) -> Self

Appends an item to eks_attempts.

To override the contents of this collection use set_eks_attempts.

A list of job attempts that are associated with this job.

Source

pub fn set_eks_attempts(self, input: Option<Vec<EksAttemptDetail>>) -> Self

A list of job attempts that are associated with this job.

Source

pub fn get_eks_attempts(&self) -> &Option<Vec<EksAttemptDetail>>

A list of job attempts that are associated with this job.

Source

pub fn ecs_properties(self, input: EcsPropertiesDetail) -> Self

An object with properties that are specific to Amazon ECS-based jobs.

Source

pub fn set_ecs_properties(self, input: Option<EcsPropertiesDetail>) -> Self

An object with properties that are specific to Amazon ECS-based jobs.

Source

pub fn get_ecs_properties(&self) -> &Option<EcsPropertiesDetail>

An object with properties that are specific to Amazon ECS-based jobs.

Source

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

Indicates whether the job is canceled.

Source

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

Indicates whether the job is canceled.

Source

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

Indicates whether the job is canceled.

Source

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

Indicates whether the job is terminated.

Source

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

Indicates whether the job is terminated.

Source

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

Indicates whether the job is terminated.

Source

pub fn consumable_resource_properties( self, input: ConsumableResourceProperties, ) -> Self

Contains a list of consumable resources required by the job.

Source

pub fn set_consumable_resource_properties( self, input: Option<ConsumableResourceProperties>, ) -> Self

Contains a list of consumable resources required by the job.

Source

pub fn get_consumable_resource_properties( &self, ) -> &Option<ConsumableResourceProperties>

Contains a list of consumable resources required by the job.

Source

pub fn build(self) -> JobDetail

Consumes the builder and constructs a JobDetail.

Trait Implementations§

Source§

impl Clone for JobDetailBuilder

Source§

fn clone(&self) -> JobDetailBuilder

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 JobDetailBuilder

Source§

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

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

impl Default for JobDetailBuilder

Source§

fn default() -> JobDetailBuilder

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

impl PartialEq for JobDetailBuilder

Source§

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

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,