aws_sdk_computeoptimizer::types

Enum ExportableAutoScalingGroupField

Source 
#[non_exhaustive]
pub enum ExportableAutoScalingGroupField {

Show 74 variants    AccountId,
    AutoScalingGroupArn,
    AutoScalingGroupName,
    CurrentConfigurationAllocationStrategy,
    CurrentConfigurationDesiredCapacity,
    CurrentConfigurationInstanceType,
    CurrentConfigurationMaxSize,
    CurrentConfigurationMinSize,
    CurrentConfigurationMixedInstanceTypes,
    CurrentConfigurationType,
    CurrentInstanceGpuInfo,
    CurrentMemory,
    CurrentNetwork,
    CurrentOnDemandPrice,
    CurrentPerformanceRisk,
    CurrentStandardOneYearNoUpfrontReservedPrice,
    CurrentStandardThreeYearNoUpfrontReservedPrice,
    CurrentStorage,
    CurrentVcpus,
    EffectiveRecommendationPreferencesCpuVendorArchitectures,
    EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics,
    EffectiveRecommendationPreferencesInferredWorkloadTypes,
    EffectiveRecommendationPreferencesLookbackPeriod,
    EffectiveRecommendationPreferencesPreferredResources,
    EffectiveRecommendationPreferencesSavingsEstimationMode,
    Finding,
    InferredWorkloadTypes,
    LastRefreshTimestamp,
    LookbackPeriodInDays,
    RecommendationOptionsConfigurationAllocationStrategy,
    RecommendationOptionsConfigurationDesiredCapacity,
    RecommendationOptionsConfigurationEstimatedInstanceHourReductionPercentage,
    RecommendationOptionsConfigurationInstanceType,
    RecommendationOptionsConfigurationMaxSize,
    RecommendationOptionsConfigurationMinSize,
    RecommendationOptionsConfigurationMixedInstanceTypes,
    RecommendationOptionsConfigurationType,
    RecommendationOptionsEstimatedMonthlySavingsCurrency,
    RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts,
    RecommendationOptionsEstimatedMonthlySavingsValue,
    RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts,
    RecommendationOptionsInstanceGpuInfo,
    RecommendationOptionsMemory,
    RecommendationOptionsMigrationEffort,
    RecommendationOptionsNetwork,
    RecommendationOptionsOnDemandPrice,
    RecommendationOptionsPerformanceRisk,
    RecommendationOptionsProjectedUtilizationMetricsCpuMaximum,
    RecommendationOptionsProjectedUtilizationMetricsGpuMemoryMaximum,
    RecommendationOptionsProjectedUtilizationMetricsGpuMaximum,
    RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum,
    RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage,
    RecommendationOptionsSavingsOpportunityPercentage,
    RecommendationOptionsStandardOneYearNoUpfrontReservedPrice,
    RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice,
    RecommendationOptionsStorage,
    RecommendationOptionsVcpus,
    UtilizationMetricsCpuMaximum,
    UtilizationMetricsDiskReadBytesPerSecondMaximum,
    UtilizationMetricsDiskReadOpsPerSecondMaximum,
    UtilizationMetricsDiskWriteBytesPerSecondMaximum,
    UtilizationMetricsDiskWriteOpsPerSecondMaximum,
    UtilizationMetricsEbsReadBytesPerSecondMaximum,
    UtilizationMetricsEbsReadOpsPerSecondMaximum,
    UtilizationMetricsEbsWriteBytesPerSecondMaximum,
    UtilizationMetricsEbsWriteOpsPerSecondMaximum,
    UtilizationMetricsGpuMemoryPercentageMaximum,
    UtilizationMetricsGpuPercentageMaximum,
    UtilizationMetricsMemoryMaximum,
    UtilizationMetricsNetworkInBytesPerSecondMaximum,
    UtilizationMetricsNetworkOutBytesPerSecondMaximum,
    UtilizationMetricsNetworkPacketsInPerSecondMaximum,
    UtilizationMetricsNetworkPacketsOutPerSecondMaximum,
    Unknown(UnknownVariantValue),

}
Expand description

When writing a match expression against ExportableAutoScalingGroupField, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Here is an example of how you can make a match expression forward-compatible:

# let exportableautoscalinggroupfield = unimplemented!();
match exportableautoscalinggroupfield {
    ExportableAutoScalingGroupField::AccountId => { /* ... */ },
    ExportableAutoScalingGroupField::AutoScalingGroupArn => { /* ... */ },
    ExportableAutoScalingGroupField::AutoScalingGroupName => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentConfigurationAllocationStrategy => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentConfigurationDesiredCapacity => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentConfigurationInstanceType => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentConfigurationMaxSize => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentConfigurationMinSize => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentConfigurationMixedInstanceTypes => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentConfigurationType => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentInstanceGpuInfo => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentMemory => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentNetwork => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentOnDemandPrice => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentPerformanceRisk => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentStandardOneYearNoUpfrontReservedPrice => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentStandardThreeYearNoUpfrontReservedPrice => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentStorage => { /* ... */ },
    ExportableAutoScalingGroupField::CurrentVcpus => { /* ... */ },
    ExportableAutoScalingGroupField::EffectiveRecommendationPreferencesCpuVendorArchitectures => { /* ... */ },
    ExportableAutoScalingGroupField::EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics => { /* ... */ },
    ExportableAutoScalingGroupField::EffectiveRecommendationPreferencesInferredWorkloadTypes => { /* ... */ },
    ExportableAutoScalingGroupField::EffectiveRecommendationPreferencesLookbackPeriod => { /* ... */ },
    ExportableAutoScalingGroupField::EffectiveRecommendationPreferencesPreferredResources => { /* ... */ },
    ExportableAutoScalingGroupField::EffectiveRecommendationPreferencesSavingsEstimationMode => { /* ... */ },
    ExportableAutoScalingGroupField::Finding => { /* ... */ },
    ExportableAutoScalingGroupField::InferredWorkloadTypes => { /* ... */ },
    ExportableAutoScalingGroupField::LastRefreshTimestamp => { /* ... */ },
    ExportableAutoScalingGroupField::LookbackPeriodInDays => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsConfigurationAllocationStrategy => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsConfigurationDesiredCapacity => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsConfigurationEstimatedInstanceHourReductionPercentage => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsConfigurationInstanceType => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsConfigurationMaxSize => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsConfigurationMinSize => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsConfigurationMixedInstanceTypes => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsConfigurationType => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsEstimatedMonthlySavingsCurrency => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsEstimatedMonthlySavingsValue => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsInstanceGpuInfo => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsMemory => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsMigrationEffort => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsNetwork => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsOnDemandPrice => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsPerformanceRisk => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsProjectedUtilizationMetricsCpuMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsProjectedUtilizationMetricsGpuMemoryMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsProjectedUtilizationMetricsGpuMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsSavingsOpportunityPercentage => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsStandardOneYearNoUpfrontReservedPrice => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsStorage => { /* ... */ },
    ExportableAutoScalingGroupField::RecommendationOptionsVcpus => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsCpuMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsDiskReadBytesPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsDiskReadOpsPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsDiskWriteBytesPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsDiskWriteOpsPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsEbsReadBytesPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsEbsReadOpsPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsEbsWriteBytesPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsEbsWriteOpsPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsGpuMemoryPercentageMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsGpuPercentageMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsMemoryMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsNetworkInBytesPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsNetworkOutBytesPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsNetworkPacketsInPerSecondMaximum => { /* ... */ },
    ExportableAutoScalingGroupField::UtilizationMetricsNetworkPacketsOutPerSecondMaximum => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

The above code demonstrates that when exportableautoscalinggroupfield represents NewFeature, the execution path will lead to the second last match arm, even though the enum does not contain a variant ExportableAutoScalingGroupField::NewFeature in the current version of SDK. The reason is that the variable other, created by the @ operator, is bound to ExportableAutoScalingGroupField::Unknown(UnknownVariantValue("NewFeature".to_owned())) and calling as_str on it yields "NewFeature". This match expression is forward-compatible when executed with a newer version of SDK where the variant ExportableAutoScalingGroupField::NewFeature is defined. Specifically, when exportableautoscalinggroupfield represents NewFeature, the execution path will hit the second last match arm as before by virtue of calling as_str on ExportableAutoScalingGroupField::NewFeature also yielding "NewFeature".

Explicitly matching on the Unknown variant should be avoided for two reasons:

  • The inner data UnknownVariantValue is opaque, and no further information can be extracted.
  • It might inadvertently shadow other intended match arms.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

AccountId

§

AutoScalingGroupArn

§

AutoScalingGroupName

§

CurrentConfigurationAllocationStrategy

§

CurrentConfigurationDesiredCapacity

§

CurrentConfigurationInstanceType

§

CurrentConfigurationMaxSize

§

CurrentConfigurationMinSize

§

CurrentConfigurationMixedInstanceTypes

§

CurrentConfigurationType

§

CurrentInstanceGpuInfo

§

CurrentMemory

§

CurrentNetwork

§

CurrentOnDemandPrice

§

CurrentPerformanceRisk

§

CurrentStandardOneYearNoUpfrontReservedPrice

§

CurrentStandardThreeYearNoUpfrontReservedPrice

§

CurrentStorage

§

CurrentVcpus

§

EffectiveRecommendationPreferencesCpuVendorArchitectures

§

EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics

§

EffectiveRecommendationPreferencesInferredWorkloadTypes

§

EffectiveRecommendationPreferencesLookbackPeriod

§

EffectiveRecommendationPreferencesPreferredResources

§

EffectiveRecommendationPreferencesSavingsEstimationMode

§

Finding

§

InferredWorkloadTypes

§

LastRefreshTimestamp

§

LookbackPeriodInDays

§

RecommendationOptionsConfigurationAllocationStrategy

§

RecommendationOptionsConfigurationDesiredCapacity

§

RecommendationOptionsConfigurationEstimatedInstanceHourReductionPercentage

§

RecommendationOptionsConfigurationInstanceType

§

RecommendationOptionsConfigurationMaxSize

§

RecommendationOptionsConfigurationMinSize

§

RecommendationOptionsConfigurationMixedInstanceTypes

§

RecommendationOptionsConfigurationType

§

RecommendationOptionsEstimatedMonthlySavingsCurrency

§

RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts

§

RecommendationOptionsEstimatedMonthlySavingsValue

§

RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts

§

RecommendationOptionsInstanceGpuInfo

§

RecommendationOptionsMemory

§

RecommendationOptionsMigrationEffort

§

RecommendationOptionsNetwork

§

RecommendationOptionsOnDemandPrice

§

RecommendationOptionsPerformanceRisk

§

RecommendationOptionsProjectedUtilizationMetricsCpuMaximum

§

RecommendationOptionsProjectedUtilizationMetricsGpuMemoryMaximum

§

RecommendationOptionsProjectedUtilizationMetricsGpuMaximum

§

RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum

§

RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage

§

RecommendationOptionsSavingsOpportunityPercentage

§

RecommendationOptionsStandardOneYearNoUpfrontReservedPrice

§

RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice

§

RecommendationOptionsStorage

§

RecommendationOptionsVcpus

§

UtilizationMetricsCpuMaximum

§

UtilizationMetricsDiskReadBytesPerSecondMaximum

§

UtilizationMetricsDiskReadOpsPerSecondMaximum

§

UtilizationMetricsDiskWriteBytesPerSecondMaximum

§

UtilizationMetricsDiskWriteOpsPerSecondMaximum

§

UtilizationMetricsEbsReadBytesPerSecondMaximum

§

UtilizationMetricsEbsReadOpsPerSecondMaximum

§

UtilizationMetricsEbsWriteBytesPerSecondMaximum

§

UtilizationMetricsEbsWriteOpsPerSecondMaximum

§

UtilizationMetricsGpuMemoryPercentageMaximum

§

UtilizationMetricsGpuPercentageMaximum

§

UtilizationMetricsMemoryMaximum

§

UtilizationMetricsNetworkInBytesPerSecondMaximum

§

UtilizationMetricsNetworkOutBytesPerSecondMaximum

§

UtilizationMetricsNetworkPacketsInPerSecondMaximum

§

UtilizationMetricsNetworkPacketsOutPerSecondMaximum

§

Unknown(UnknownVariantValue)

👎Deprecated: Don’t directly match on Unknown. See the docs on this enum for the correct way to handle unknown variants.

Unknown contains new variants that have been added since this code was generated.

Implementations§

Source§

impl ExportableAutoScalingGroupField

Source

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

Source

pub const fn values() -> &'static [&'static str]

Returns all the &str representations of the enum members.

Source§

impl ExportableAutoScalingGroupField

Source

pub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>

Parses the enum value while disallowing unknown variants.

Unknown variants will result in an error.

Trait Implementations§

Source§

impl AsRef<str> for ExportableAutoScalingGroupField

Source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for ExportableAutoScalingGroupField

Source§

fn clone(&self) -> ExportableAutoScalingGroupField

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 ExportableAutoScalingGroupField

Source§

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

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

impl Display for ExportableAutoScalingGroupField

Source§

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

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

impl From<&str> for ExportableAutoScalingGroupField

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl FromStr for ExportableAutoScalingGroupField

Source§

type Err = Infallible

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, <Self as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for ExportableAutoScalingGroupField

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ExportableAutoScalingGroupField

Source§

fn cmp(&self, other: &ExportableAutoScalingGroupField) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ExportableAutoScalingGroupField

Source§

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

Source§

fn partial_cmp( &self, other: &ExportableAutoScalingGroupField, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Eq for ExportableAutoScalingGroupField

Source§

impl StructuralPartialEq for ExportableAutoScalingGroupField

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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,