Skip to main content

DefaultRunSettingBuilder

aws_sdk_omics::types::builders

Struct DefaultRunSettingBuilder 

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

A builder for DefaultRunSetting.

Implementations§

Source§

impl DefaultRunSettingBuilder

Source

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

The identifier of the workflow to run.

This field is required.
Source

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

The identifier of the workflow to run.

Source

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

The identifier of the workflow to run.

Source

pub fn workflow_type(self, input: WorkflowType) -> Self

The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

Source

pub fn set_workflow_type(self, input: Option<WorkflowType>) -> Self

The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

Source

pub fn get_workflow_type(&self) -> &Option<WorkflowType>

The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

Source

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

The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.

This field is required.
Source

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

The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.

Source

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

The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.

Source

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

An optional user-friendly name applied to each workflow run. Can be overridden per run.

Source

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

An optional user-friendly name applied to each workflow run. Can be overridden per run.

Source

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

An optional user-friendly name applied to each workflow run. Can be overridden per run.

Source

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

The identifier of the run cache to associate with the runs.

Source

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

The identifier of the run cache to associate with the runs.

Source

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

The identifier of the run cache to associate with the runs.

Source

pub fn cache_behavior(self, input: CacheBehavior) -> Self

The cache behavior for the runs. Requires cacheId to be set.

Source

pub fn set_cache_behavior(self, input: Option<CacheBehavior>) -> Self

The cache behavior for the runs. Requires cacheId to be set.

Source

pub fn get_cache_behavior(&self) -> &Option<CacheBehavior>

The cache behavior for the runs. Requires cacheId to be set.

Source

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

The ID of the run group to contain all workflow runs in the batch.

Source

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

The ID of the run group to contain all workflow runs in the batch.

Source

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

The ID of the run group to contain all workflow runs in the batch.

Source

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

An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.

Source

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

An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.

Source

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

An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.

Source

pub fn parameters(self, input: Document) -> Self

Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.

Source

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

Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.

Source

pub fn get_parameters(&self) -> &Option<Document>

Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.

Source

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

The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.

Source

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

The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.

Source

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

The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.

Source

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

The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.

Source

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

The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.

Source

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

The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.

Source

pub fn log_level(self, input: RunLogLevel) -> Self

The verbosity level for CloudWatch Logs emitted during each run.

Source

pub fn set_log_level(self, input: Option<RunLogLevel>) -> Self

The verbosity level for CloudWatch Logs emitted during each run.

Source

pub fn get_log_level(&self) -> &Option<RunLogLevel>

The verbosity level for CloudWatch Logs emitted during each run.

Source

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

Adds a key-value pair to run_tags.

To override the contents of this collection use set_run_tags.

AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.

Source

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

AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.

Source

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

AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.

Source

pub fn retention_mode(self, input: RunRetentionMode) -> Self

The retention behavior for runs after completion.

Source

pub fn set_retention_mode(self, input: Option<RunRetentionMode>) -> Self

The retention behavior for runs after completion.

Source

pub fn get_retention_mode(&self) -> &Option<RunRetentionMode>

The retention behavior for runs after completion.

Source

pub fn storage_type(self, input: StorageType) -> Self

The storage type for the workflow runs.

Source

pub fn set_storage_type(self, input: Option<StorageType>) -> Self

The storage type for the workflow runs.

Source

pub fn get_storage_type(&self) -> &Option<StorageType>

The storage type for the workflow runs.

Source

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

The AWS account ID of the workflow owner, used for cross-account workflow sharing.

Source

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

The AWS account ID of the workflow owner, used for cross-account workflow sharing.

Source

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

The AWS account ID of the workflow owner, used for cross-account workflow sharing.

Source

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

The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

Source

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

The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

Source

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

The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

Source

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

The version name of the specified workflow.

Source

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

The version name of the specified workflow.

Source

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

The version name of the specified workflow.

Source

pub fn networking_mode(self, input: NetworkingMode) -> Self

Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.

Source

pub fn set_networking_mode(self, input: Option<NetworkingMode>) -> Self

Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.

Source

pub fn get_networking_mode(&self) -> &Option<NetworkingMode>

Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.

Source

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

Optional configuration name to use for the workflow run.

Source

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

Optional configuration name to use for the workflow run.

Source

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

Optional configuration name to use for the workflow run.

Source

pub fn engine_settings(self, input: Document) -> Self

Engine-specific settings for the workflow run. Use this field to specify configuration options that are specific to the workflow engine (for example, Nextflow profiles).

Source

pub fn set_engine_settings(self, input: Option<Document>) -> Self

Engine-specific settings for the workflow run. Use this field to specify configuration options that are specific to the workflow engine (for example, Nextflow profiles).

Source

pub fn get_engine_settings(&self) -> &Option<Document>

Engine-specific settings for the workflow run. Use this field to specify configuration options that are specific to the workflow engine (for example, Nextflow profiles).

Source

pub fn scratch_storage_mode(self, input: ScratchStorageMode) -> Self

Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If not specified, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL.

Source

pub fn set_scratch_storage_mode(self, input: Option<ScratchStorageMode>) -> Self

Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If not specified, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL.

Source

pub fn get_scratch_storage_mode(&self) -> &Option<ScratchStorageMode>

Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If not specified, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL.

Source

pub fn build(self) -> Result<DefaultRunSetting, BuildError>

Consumes the builder and constructs a DefaultRunSetting. This method will fail if any of the following fields are not set:

Trait Implementations§

Source§

impl Clone for DefaultRunSettingBuilder

Source§

fn clone(&self) -> DefaultRunSettingBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DefaultRunSettingBuilder

Source§

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

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

impl Default for DefaultRunSettingBuilder

Source§

fn default() -> DefaultRunSettingBuilder

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

impl PartialEq for DefaultRunSettingBuilder

Source§

fn eq(&self, other: &DefaultRunSettingBuilder) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DefaultRunSettingBuilder

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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