Struct aws_sdk_securityhub::types::builders::AwsCloudWatchAlarmDetailsBuilder

source · 
#[non_exhaustive]
pub struct AwsCloudWatchAlarmDetailsBuilder { /* private fields */ }
Expand description

A builder for AwsCloudWatchAlarmDetails.

Implementations§

source§

impl AwsCloudWatchAlarmDetailsBuilder

source

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

Indicates whether actions should be executed during any changes to the alarm state.

source

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

Indicates whether actions should be executed during any changes to the alarm state.

source

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

Indicates whether actions should be executed during any changes to the alarm state.

source

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

Appends an item to alarm_actions.

To override the contents of this collection use set_alarm_actions.

The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.

source

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

The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.

source

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

The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.

source

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

The ARN of the alarm.

source

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

The ARN of the alarm.

source

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

The ARN of the alarm.

source

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

The time stamp of the last update to the alarm configuration.

source

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

The time stamp of the last update to the alarm configuration.

source

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

The time stamp of the last update to the alarm configuration.

source

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

The description of the alarm.

source

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

The description of the alarm.

source

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

The description of the alarm.

source

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

The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.

source

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

The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.

source

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

The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.

source

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

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

source

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

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

source

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

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

source

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

The number of datapoints that must be breaching to trigger the alarm.

source

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

The number of datapoints that must be breaching to trigger the alarm.

source

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

The number of datapoints that must be breaching to trigger the alarm.

source

pub fn dimensions(self, input: AwsCloudWatchAlarmDimensionsDetails) -> Self

Appends an item to dimensions.

To override the contents of this collection use set_dimensions.

The dimensions for the metric associated with the alarm.

source

pub fn set_dimensions( self, input: Option<Vec<AwsCloudWatchAlarmDimensionsDetails>>, ) -> Self

The dimensions for the metric associated with the alarm.

source

pub fn get_dimensions( &self, ) -> &Option<Vec<AwsCloudWatchAlarmDimensionsDetails>>

The dimensions for the metric associated with the alarm.

source

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

Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

source

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

Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

source

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

Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

source

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

The number of periods over which data is compared to the specified threshold.

source

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

The number of periods over which data is compared to the specified threshold.

source

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

The number of periods over which data is compared to the specified threshold.

source

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

The percentile statistic for the metric associated with the alarm.

source

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

The percentile statistic for the metric associated with the alarm.

source

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

The percentile statistic for the metric associated with the alarm.

source

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

Appends an item to insufficient_data_actions.

To override the contents of this collection use set_insufficient_data_actions.

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.

source

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

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.

source

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

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.

source

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

The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.

source

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

The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.

source

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

The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.

source

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

The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

source

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

The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

source

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

The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

source

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

Appends an item to ok_actions.

To override the contents of this collection use set_ok_actions.

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an ARN.

source

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

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an ARN.

source

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

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an ARN.

source

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

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.

source

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

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.

source

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

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.

source

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

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.

source

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

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.

source

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

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.

source

pub fn threshold(self, input: f64) -> Self

The value to compare with the specified statistic.

source

pub fn set_threshold(self, input: Option<f64>) -> Self

The value to compare with the specified statistic.

source

pub fn get_threshold(&self) -> &Option<f64>

The value to compare with the specified statistic.

source

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

n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

source

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

n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

source

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

n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

source

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

Sets how this alarm is to handle missing data points.

source

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

Sets how this alarm is to handle missing data points.

source

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

Sets how this alarm is to handle missing data points.

source

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

The unit of the metric associated with the alarm.

source

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

The unit of the metric associated with the alarm.

source

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

The unit of the metric associated with the alarm.

source

pub fn build(self) -> AwsCloudWatchAlarmDetails

Consumes the builder and constructs a AwsCloudWatchAlarmDetails.

Trait Implementations§

source§

impl Clone for AwsCloudWatchAlarmDetailsBuilder

source§

fn clone(&self) -> AwsCloudWatchAlarmDetailsBuilder

Returns a copy 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 AwsCloudWatchAlarmDetailsBuilder

source§

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

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

impl Default for AwsCloudWatchAlarmDetailsBuilder

source§

fn default() -> AwsCloudWatchAlarmDetailsBuilder

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

impl PartialEq for AwsCloudWatchAlarmDetailsBuilder

source§

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

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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