AwsEc2LaunchTemplateDataInstanceRequirementsDetailsBuilder

aws_sdk_securityhub::types::builders

Struct AwsEc2LaunchTemplateDataInstanceRequirementsDetailsBuilder 

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

A builder for AwsEc2LaunchTemplateDataInstanceRequirementsDetails.

Implementations§

Source§

impl AwsEc2LaunchTemplateDataInstanceRequirementsDetailsBuilder

Source

pub fn accelerator_count( self, input: AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails, ) -> Self

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.

Source

pub fn set_accelerator_count( self, input: Option<AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails>, ) -> Self

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.

Source

pub fn get_accelerator_count( &self, ) -> &Option<AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails>

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.

Source

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

Appends an item to accelerator_manufacturers.

To override the contents of this collection use set_accelerator_manufacturers.

Indicates whether instance types must have accelerators by specific manufacturers.

Source

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

Indicates whether instance types must have accelerators by specific manufacturers.

Source

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

Indicates whether instance types must have accelerators by specific manufacturers.

Source

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

Appends an item to accelerator_names.

To override the contents of this collection use set_accelerator_names.

The accelerators that must be on the instance type.

Source

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

The accelerators that must be on the instance type.

Source

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

The accelerators that must be on the instance type.

Source

pub fn accelerator_total_memory_mib( self, input: AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails, ) -> Self

The minimum and maximum amount of total accelerator memory, in MiB.

Source

pub fn set_accelerator_total_memory_mib( self, input: Option<AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails>, ) -> Self

The minimum and maximum amount of total accelerator memory, in MiB.

Source

pub fn get_accelerator_total_memory_mib( &self, ) -> &Option<AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails>

The minimum and maximum amount of total accelerator memory, in MiB.

Source

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

Appends an item to accelerator_types.

To override the contents of this collection use set_accelerator_types.

The accelerator types that must be on the instance type.

Source

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

The accelerator types that must be on the instance type.

Source

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

The accelerator types that must be on the instance type.

Source

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

Indicates whether bare metal instance types must be included, excluded, or required.

Source

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

Indicates whether bare metal instance types must be included, excluded, or required.

Source

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

Indicates whether bare metal instance types must be included, excluded, or required.

Source

pub fn baseline_ebs_bandwidth_mbps( self, input: AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails, ) -> Self

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS optimized instances in the Amazon EC2 User Guide.

Source

pub fn set_baseline_ebs_bandwidth_mbps( self, input: Option<AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails>, ) -> Self

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS optimized instances in the Amazon EC2 User Guide.

Source

pub fn get_baseline_ebs_bandwidth_mbps( &self, ) -> &Option<AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails>

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS optimized instances in the Amazon EC2 User Guide.

Source

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

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, Burstable performance instances in the Amazon EC2 User Guide.

Source

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

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, Burstable performance instances in the Amazon EC2 User Guide.

Source

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

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, Burstable performance instances in the Amazon EC2 User Guide.

Source

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

Appends an item to cpu_manufacturers.

To override the contents of this collection use set_cpu_manufacturers.

The CPU manufacturers to include.

Source

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

The CPU manufacturers to include.

Source

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

The CPU manufacturers to include.

Source

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

Appends an item to excluded_instance_types.

To override the contents of this collection use set_excluded_instance_types.

The instance types to exclude.

Source

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

The instance types to exclude.

Source

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

The instance types to exclude.

Source

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

Appends an item to instance_generations.

To override the contents of this collection use set_instance_generations.

Indicates whether current or previous generation instance types are included.

Source

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

Indicates whether current or previous generation instance types are included.

Source

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

Indicates whether current or previous generation instance types are included.

Source

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

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.

Source

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

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.

Source

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

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.

Source

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

Appends an item to local_storage_types.

To override the contents of this collection use set_local_storage_types.

The type of local storage that is required.

Source

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

The type of local storage that is required.

Source

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

The type of local storage that is required.

Source

pub fn memory_gib_per_v_cpu( self, input: AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails, ) -> Self

The minimum and maximum amount of memory per vCPU, in GiB.

Source

pub fn set_memory_gib_per_v_cpu( self, input: Option<AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails>, ) -> Self

The minimum and maximum amount of memory per vCPU, in GiB.

Source

pub fn get_memory_gib_per_v_cpu( &self, ) -> &Option<AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails>

The minimum and maximum amount of memory per vCPU, in GiB.

Source

pub fn memory_mib( self, input: AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails, ) -> Self

The minimum and maximum amount of memory, in MiB.

Source

pub fn set_memory_mib( self, input: Option<AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails>, ) -> Self

The minimum and maximum amount of memory, in MiB.

Source

pub fn get_memory_mib( &self, ) -> &Option<AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails>

The minimum and maximum amount of memory, in MiB.

Source

pub fn network_interface_count( self, input: AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails, ) -> Self

The minimum and maximum number of network interfaces.

Source

pub fn set_network_interface_count( self, input: Option<AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails>, ) -> Self

The minimum and maximum number of network interfaces.

Source

pub fn get_network_interface_count( &self, ) -> &Option<AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails>

The minimum and maximum number of network interfaces.

Source

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

The price protection threshold for On-Demand Instances. This is the maximum you'll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

A high value, such as 999999, turns off price protection.

Source

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

The price protection threshold for On-Demand Instances. This is the maximum you'll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

A high value, such as 999999, turns off price protection.

Source

pub fn get_on_demand_max_price_percentage_over_lowest_price( &self, ) -> &Option<i32>

The price protection threshold for On-Demand Instances. This is the maximum you'll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

A high value, such as 999999, turns off price protection.

Source

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

Indicates whether instance types must support hibernation for On-Demand Instances.

Source

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

Indicates whether instance types must support hibernation for On-Demand Instances.

Source

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

Indicates whether instance types must support hibernation for On-Demand Instances.

Source

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

The price protection threshold for Spot Instances. This is the maximum you'll pay for a Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

A high value, such as 999999, turns off price protection.

Source

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

The price protection threshold for Spot Instances. This is the maximum you'll pay for a Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

A high value, such as 999999, turns off price protection.

Source

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

The price protection threshold for Spot Instances. This is the maximum you'll pay for a Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

A high value, such as 999999, turns off price protection.

Source

pub fn total_local_storage_gb( self, input: AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGbDetails, ) -> Self

The minimum and maximum amount of total local storage, in GB.

Source

pub fn set_total_local_storage_gb( self, input: Option<AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGbDetails>, ) -> Self

The minimum and maximum amount of total local storage, in GB.

Source

pub fn get_total_local_storage_gb( &self, ) -> &Option<AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGbDetails>

The minimum and maximum amount of total local storage, in GB.

Source

pub fn v_cpu_count( self, input: AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails, ) -> Self

The minimum and maximum number of vCPUs.

Source

pub fn set_v_cpu_count( self, input: Option<AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails>, ) -> Self

The minimum and maximum number of vCPUs.

Source

pub fn get_v_cpu_count( &self, ) -> &Option<AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails>

The minimum and maximum number of vCPUs.

Source

pub fn build(self) -> AwsEc2LaunchTemplateDataInstanceRequirementsDetails

Consumes the builder and constructs a AwsEc2LaunchTemplateDataInstanceRequirementsDetails.

Trait Implementations§

Source§

impl Clone for AwsEc2LaunchTemplateDataInstanceRequirementsDetailsBuilder

Source§

fn clone(&self) -> AwsEc2LaunchTemplateDataInstanceRequirementsDetailsBuilder

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 AwsEc2LaunchTemplateDataInstanceRequirementsDetailsBuilder

Source§

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

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

impl Default for AwsEc2LaunchTemplateDataInstanceRequirementsDetailsBuilder

Source§

fn default() -> AwsEc2LaunchTemplateDataInstanceRequirementsDetailsBuilder

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

impl PartialEq for AwsEc2LaunchTemplateDataInstanceRequirementsDetailsBuilder

Source§

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

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,