InstanceRequirementsRequestBuilder

aws_sdk_ecs::types::builders

Struct InstanceRequirementsRequestBuilder 

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

A builder for InstanceRequirementsRequest.

Implementations§

Source§

impl InstanceRequirementsRequestBuilder

Source

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

The minimum and maximum number of vCPUs for the instance types. Amazon ECS selects instance types that have vCPU counts within this range.

This field is required.
Source

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

The minimum and maximum number of vCPUs for the instance types. Amazon ECS selects instance types that have vCPU counts within this range.

Source

pub fn get_v_cpu_count(&self) -> &Option<VCpuCountRangeRequest>

The minimum and maximum number of vCPUs for the instance types. Amazon ECS selects instance types that have vCPU counts within this range.

Source

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

The minimum and maximum amount of memory in mebibytes (MiB) for the instance types. Amazon ECS selects instance types that have memory within this range.

This field is required.
Source

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

The minimum and maximum amount of memory in mebibytes (MiB) for the instance types. Amazon ECS selects instance types that have memory within this range.

Source

pub fn get_memory_mib(&self) -> &Option<MemoryMiBRequest>

The minimum and maximum amount of memory in mebibytes (MiB) for the instance types. Amazon ECS selects instance types that have memory within this range.

Source

pub fn cpu_manufacturers(self, input: CpuManufacturer) -> Self

Appends an item to cpu_manufacturers.

To override the contents of this collection use set_cpu_manufacturers.

The CPU manufacturers to include or exclude. You can specify intel, amd, or amazon-web-services to control which CPU types are used for your workloads.

Source

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

The CPU manufacturers to include or exclude. You can specify intel, amd, or amazon-web-services to control which CPU types are used for your workloads.

Source

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

The CPU manufacturers to include or exclude. You can specify intel, amd, or amazon-web-services to control which CPU types are used for your workloads.

Source

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

The minimum and maximum amount of memory per vCPU in gibibytes (GiB). This helps ensure that instance types have the appropriate memory-to-CPU ratio for your workloads.

Source

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

The minimum and maximum amount of memory per vCPU in gibibytes (GiB). This helps ensure that instance types have the appropriate memory-to-CPU ratio for your workloads.

Source

pub fn get_memory_gib_per_v_cpu(&self) -> &Option<MemoryGiBPerVCpuRequest>

The minimum and maximum amount of memory per vCPU in gibibytes (GiB). This helps ensure that instance types have the appropriate memory-to-CPU ratio for your workloads.

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 from selection. Use this to prevent Amazon ECS from selecting specific instance types that may not be suitable for your workloads.

Source

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

The instance types to exclude from selection. Use this to prevent Amazon ECS from selecting specific instance types that may not be suitable for your workloads.

Source

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

The instance types to exclude from selection. Use this to prevent Amazon ECS from selecting specific instance types that may not be suitable for your workloads.

Source

pub fn instance_generations(self, input: InstanceGeneration) -> Self

Appends an item to instance_generations.

To override the contents of this collection use set_instance_generations.

The instance generations to include. You can specify current to use the latest generation instances, or previous to include previous generation instances for cost optimization.

Source

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

The instance generations to include. You can specify current to use the latest generation instances, or previous to include previous generation instances for cost optimization.

Source

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

The instance generations to include. You can specify current to use the latest generation instances, or previous to include previous generation instances for cost optimization.

Source

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

The maximum price for Spot instances as a percentage over the lowest priced On-Demand instance. This helps control Spot instance costs while maintaining access to capacity.

Source

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

The maximum price for Spot instances as a percentage over the lowest priced On-Demand instance. This helps control Spot instance costs while maintaining access to capacity.

Source

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

The maximum price for Spot instances as a percentage over the lowest priced On-Demand instance. This helps control Spot instance costs while maintaining access to capacity.

Source

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

The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon ECS selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

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, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon ECS selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

Source

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

The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon ECS selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

Source

pub fn bare_metal(self, input: BareMetal) -> Self

Indicates whether to include bare metal instance types. Set to included to allow bare metal instances, excluded to exclude them, or required to use only bare metal instances.

Source

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

Indicates whether to include bare metal instance types. Set to included to allow bare metal instances, excluded to exclude them, or required to use only bare metal instances.

Source

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

Indicates whether to include bare metal instance types. Set to included to allow bare metal instances, excluded to exclude them, or required to use only bare metal instances.

Source

pub fn burstable_performance(self, input: BurstablePerformance) -> Self

Indicates whether to include burstable performance instance types (T2, T3, T3a, T4g). Set to included to allow burstable instances, excluded to exclude them, or required to use only burstable instances.

Source

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

Indicates whether to include burstable performance instance types (T2, T3, T3a, T4g). Set to included to allow burstable instances, excluded to exclude them, or required to use only burstable instances.

Source

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

Indicates whether to include burstable performance instance types (T2, T3, T3a, T4g). Set to included to allow burstable instances, excluded to exclude them, or required to use only burstable instances.

Source

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

Indicates whether the instance types must support hibernation. When set to true, only instance types that support hibernation are selected.

Source

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

Indicates whether the instance types must support hibernation. When set to true, only instance types that support hibernation are selected.

Source

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

Indicates whether the instance types must support hibernation. When set to true, only instance types that support hibernation are selected.

Source

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

The minimum and maximum number of network interfaces for the instance types. This is useful for workloads that require multiple network interfaces.

Source

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

The minimum and maximum number of network interfaces for the instance types. This is useful for workloads that require multiple network interfaces.

Source

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

The minimum and maximum number of network interfaces for the instance types. This is useful for workloads that require multiple network interfaces.

Source

pub fn local_storage(self, input: LocalStorage) -> Self

Indicates whether to include instance types with local storage. Set to included to allow local storage, excluded to exclude it, or required to use only instances with local storage.

Source

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

Indicates whether to include instance types with local storage. Set to included to allow local storage, excluded to exclude it, or required to use only instances with local storage.

Source

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

Indicates whether to include instance types with local storage. Set to included to allow local storage, excluded to exclude it, or required to use only instances with local storage.

Source

pub fn local_storage_types(self, input: LocalStorageType) -> Self

Appends an item to local_storage_types.

To override the contents of this collection use set_local_storage_types.

The local storage types to include. You can specify hdd for hard disk drives, ssd for solid state drives, or both.

Source

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

The local storage types to include. You can specify hdd for hard disk drives, ssd for solid state drives, or both.

Source

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

The local storage types to include. You can specify hdd for hard disk drives, ssd for solid state drives, or both.

Source

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

The minimum and maximum total local storage in gigabytes (GB) for instance types with local storage.

Source

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

The minimum and maximum total local storage in gigabytes (GB) for instance types with local storage.

Source

pub fn get_total_local_storage_gb(&self) -> &Option<TotalLocalStorageGbRequest>

The minimum and maximum total local storage in gigabytes (GB) for instance types with local storage.

Source

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

The minimum and maximum baseline Amazon EBS bandwidth in megabits per second (Mbps). This is important for workloads with high storage I/O requirements.

Source

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

The minimum and maximum baseline Amazon EBS bandwidth in megabits per second (Mbps). This is important for workloads with high storage I/O requirements.

Source

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

The minimum and maximum baseline Amazon EBS bandwidth in megabits per second (Mbps). This is important for workloads with high storage I/O requirements.

Source

pub fn accelerator_types(self, input: AcceleratorType) -> Self

Appends an item to accelerator_types.

To override the contents of this collection use set_accelerator_types.

The accelerator types to include. You can specify gpu for graphics processing units, fpga for field programmable gate arrays, or inference for machine learning inference accelerators.

Source

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

The accelerator types to include. You can specify gpu for graphics processing units, fpga for field programmable gate arrays, or inference for machine learning inference accelerators.

Source

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

The accelerator types to include. You can specify gpu for graphics processing units, fpga for field programmable gate arrays, or inference for machine learning inference accelerators.

Source

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

The minimum and maximum number of accelerators for the instance types. This is used when you need instances with specific numbers of GPUs or other accelerators.

Source

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

The minimum and maximum number of accelerators for the instance types. This is used when you need instances with specific numbers of GPUs or other accelerators.

Source

pub fn get_accelerator_count(&self) -> &Option<AcceleratorCountRequest>

The minimum and maximum number of accelerators for the instance types. This is used when you need instances with specific numbers of GPUs or other accelerators.

Source

pub fn accelerator_manufacturers(self, input: AcceleratorManufacturer) -> Self

Appends an item to accelerator_manufacturers.

To override the contents of this collection use set_accelerator_manufacturers.

The accelerator manufacturers to include. You can specify nvidia, amd, amazon-web-services, or xilinx depending on your accelerator requirements.

Source

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

The accelerator manufacturers to include. You can specify nvidia, amd, amazon-web-services, or xilinx depending on your accelerator requirements.

Source

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

The accelerator manufacturers to include. You can specify nvidia, amd, amazon-web-services, or xilinx depending on your accelerator requirements.

Source

pub fn accelerator_names(self, input: AcceleratorName) -> Self

Appends an item to accelerator_names.

To override the contents of this collection use set_accelerator_names.

The specific accelerator names to include. For example, you can specify a100, v100, k80, or other specific accelerator models.

Source

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

The specific accelerator names to include. For example, you can specify a100, v100, k80, or other specific accelerator models.

Source

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

The specific accelerator names to include. For example, you can specify a100, v100, k80, or other specific accelerator models.

Source

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

The minimum and maximum total accelerator memory in mebibytes (MiB). This is important for GPU workloads that require specific amounts of video memory.

Source

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

The minimum and maximum total accelerator memory in mebibytes (MiB). This is important for GPU workloads that require specific amounts of video memory.

Source

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

The minimum and maximum total accelerator memory in mebibytes (MiB). This is important for GPU workloads that require specific amounts of video memory.

Source

pub fn network_bandwidth_gbps(self, input: NetworkBandwidthGbpsRequest) -> Self

The minimum and maximum network bandwidth in gigabits per second (Gbps). This is crucial for network-intensive workloads that require high throughput.

Source

pub fn set_network_bandwidth_gbps( self, input: Option<NetworkBandwidthGbpsRequest>, ) -> Self

The minimum and maximum network bandwidth in gigabits per second (Gbps). This is crucial for network-intensive workloads that require high throughput.

Source

pub fn get_network_bandwidth_gbps(&self) -> &Option<NetworkBandwidthGbpsRequest>

The minimum and maximum network bandwidth in gigabits per second (Gbps). This is crucial for network-intensive workloads that require high throughput.

Source

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

Appends an item to allowed_instance_types.

To override the contents of this collection use set_allowed_instance_types.

The instance types to include in the selection. When specified, Amazon ECS only considers these instance types, subject to the other requirements specified.

Source

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

The instance types to include in the selection. When specified, Amazon ECS only considers these instance types, subject to the other requirements specified.

Source

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

The instance types to include in the selection. When specified, Amazon ECS only considers these instance types, subject to the other requirements specified.

Source

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

The maximum price for Spot instances as a percentage of the optimal On-Demand price. This provides more precise cost control for Spot instance selection.

Source

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

The maximum price for Spot instances as a percentage of the optimal On-Demand price. This provides more precise cost control for Spot instance selection.

Source

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

The maximum price for Spot instances as a percentage of the optimal On-Demand price. This provides more precise cost control for Spot instance selection.

Source

pub fn build(self) -> InstanceRequirementsRequest

Consumes the builder and constructs a InstanceRequirementsRequest.

Trait Implementations§

Source§

impl Clone for InstanceRequirementsRequestBuilder

Source§

fn clone(&self) -> InstanceRequirementsRequestBuilder

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 InstanceRequirementsRequestBuilder

Source§

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

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

impl Default for InstanceRequirementsRequestBuilder

Source§

fn default() -> InstanceRequirementsRequestBuilder

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

impl PartialEq for InstanceRequirementsRequestBuilder

Source§

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

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,