aws_sdk_ec2::types::builders

Struct InstanceTypeInfoBuilder

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

A builder for InstanceTypeInfo.

Implementations§

Source§

impl InstanceTypeInfoBuilder

Source

pub fn instance_type(self, input: InstanceType) -> Self

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

Source

pub fn set_instance_type(self, input: Option<InstanceType>) -> Self

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

Source

pub fn get_instance_type(&self) -> &Option<InstanceType>

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

Source

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

Indicates whether the instance type is current generation.

Source

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

Indicates whether the instance type is current generation.

Source

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

Indicates whether the instance type is current generation.

Source

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

Indicates whether the instance type is eligible for the free tier.

Source

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

Indicates whether the instance type is eligible for the free tier.

Source

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

Indicates whether the instance type is eligible for the free tier.

Source

pub fn supported_usage_classes(self, input: UsageClassType) -> Self

Appends an item to supported_usage_classes.

To override the contents of this collection use set_supported_usage_classes.

Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks.

Source

pub fn set_supported_usage_classes( self, input: Option<Vec<UsageClassType>>, ) -> Self

Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks.

Source

pub fn get_supported_usage_classes(&self) -> &Option<Vec<UsageClassType>>

Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks.

Source

pub fn supported_root_device_types(self, input: RootDeviceType) -> Self

Appends an item to supported_root_device_types.

To override the contents of this collection use set_supported_root_device_types.

The supported root device types.

Source

pub fn set_supported_root_device_types( self, input: Option<Vec<RootDeviceType>>, ) -> Self

The supported root device types.

Source

pub fn get_supported_root_device_types(&self) -> &Option<Vec<RootDeviceType>>

The supported root device types.

Source

pub fn supported_virtualization_types(self, input: VirtualizationType) -> Self

Appends an item to supported_virtualization_types.

To override the contents of this collection use set_supported_virtualization_types.

The supported virtualization types.

Source

pub fn set_supported_virtualization_types( self, input: Option<Vec<VirtualizationType>>, ) -> Self

The supported virtualization types.

Source

pub fn get_supported_virtualization_types( &self, ) -> &Option<Vec<VirtualizationType>>

The supported virtualization types.

Source

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

Indicates whether the instance is a bare metal instance type.

Source

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

Indicates whether the instance is a bare metal instance type.

Source

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

Indicates whether the instance is a bare metal instance type.

Source

pub fn hypervisor(self, input: InstanceTypeHypervisor) -> Self

The hypervisor for the instance type.

Source

pub fn set_hypervisor(self, input: Option<InstanceTypeHypervisor>) -> Self

The hypervisor for the instance type.

Source

pub fn get_hypervisor(&self) -> &Option<InstanceTypeHypervisor>

The hypervisor for the instance type.

Source

pub fn processor_info(self, input: ProcessorInfo) -> Self

Describes the processor.

Source

pub fn set_processor_info(self, input: Option<ProcessorInfo>) -> Self

Describes the processor.

Source

pub fn get_processor_info(&self) -> &Option<ProcessorInfo>

Describes the processor.

Source

pub fn v_cpu_info(self, input: VCpuInfo) -> Self

Describes the vCPU configurations for the instance type.

Source

pub fn set_v_cpu_info(self, input: Option<VCpuInfo>) -> Self

Describes the vCPU configurations for the instance type.

Source

pub fn get_v_cpu_info(&self) -> &Option<VCpuInfo>

Describes the vCPU configurations for the instance type.

Source

pub fn memory_info(self, input: MemoryInfo) -> Self

Describes the memory for the instance type.

Source

pub fn set_memory_info(self, input: Option<MemoryInfo>) -> Self

Describes the memory for the instance type.

Source

pub fn get_memory_info(&self) -> &Option<MemoryInfo>

Describes the memory for the instance type.

Source

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

Indicates whether instance storage is supported.

Source

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

Indicates whether instance storage is supported.

Source

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

Indicates whether instance storage is supported.

Source

pub fn instance_storage_info(self, input: InstanceStorageInfo) -> Self

Describes the instance storage for the instance type.

Source

pub fn set_instance_storage_info( self, input: Option<InstanceStorageInfo>, ) -> Self

Describes the instance storage for the instance type.

Source

pub fn get_instance_storage_info(&self) -> &Option<InstanceStorageInfo>

Describes the instance storage for the instance type.

Source

pub fn ebs_info(self, input: EbsInfo) -> Self

Describes the Amazon EBS settings for the instance type.

Source

pub fn set_ebs_info(self, input: Option<EbsInfo>) -> Self

Describes the Amazon EBS settings for the instance type.

Source

pub fn get_ebs_info(&self) -> &Option<EbsInfo>

Describes the Amazon EBS settings for the instance type.

Source

pub fn network_info(self, input: NetworkInfo) -> Self

Describes the network settings for the instance type.

Source

pub fn set_network_info(self, input: Option<NetworkInfo>) -> Self

Describes the network settings for the instance type.

Source

pub fn get_network_info(&self) -> &Option<NetworkInfo>

Describes the network settings for the instance type.

Source

pub fn gpu_info(self, input: GpuInfo) -> Self

Describes the GPU accelerator settings for the instance type.

Source

pub fn set_gpu_info(self, input: Option<GpuInfo>) -> Self

Describes the GPU accelerator settings for the instance type.

Source

pub fn get_gpu_info(&self) -> &Option<GpuInfo>

Describes the GPU accelerator settings for the instance type.

Source

pub fn fpga_info(self, input: FpgaInfo) -> Self

Describes the FPGA accelerator settings for the instance type.

Source

pub fn set_fpga_info(self, input: Option<FpgaInfo>) -> Self

Describes the FPGA accelerator settings for the instance type.

Source

pub fn get_fpga_info(&self) -> &Option<FpgaInfo>

Describes the FPGA accelerator settings for the instance type.

Source

pub fn placement_group_info(self, input: PlacementGroupInfo) -> Self

Describes the placement group settings for the instance type.

Source

pub fn set_placement_group_info(self, input: Option<PlacementGroupInfo>) -> Self

Describes the placement group settings for the instance type.

Source

pub fn get_placement_group_info(&self) -> &Option<PlacementGroupInfo>

Describes the placement group settings for the instance type.

Source

pub fn inference_accelerator_info(self, input: InferenceAcceleratorInfo) -> Self

Describes the Inference accelerator settings for the instance type.

Source

pub fn set_inference_accelerator_info( self, input: Option<InferenceAcceleratorInfo>, ) -> Self

Describes the Inference accelerator settings for the instance type.

Source

pub fn get_inference_accelerator_info( &self, ) -> &Option<InferenceAcceleratorInfo>

Describes the Inference accelerator settings for the instance type.

Source

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

Indicates whether On-Demand hibernation is supported.

Source

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

Indicates whether On-Demand hibernation is supported.

Source

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

Indicates whether On-Demand hibernation is supported.

Source

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

Indicates whether the instance type is a burstable performance T instance type. For more information, see Burstable performance instances.

Source

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

Indicates whether the instance type is a burstable performance T instance type. For more information, see Burstable performance instances.

Source

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

Indicates whether the instance type is a burstable performance T instance type. For more information, see Burstable performance instances.

Source

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

Indicates whether Dedicated Hosts are supported on the instance type.

Source

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

Indicates whether Dedicated Hosts are supported on the instance type.

Source

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

Indicates whether Dedicated Hosts are supported on the instance type.

Source

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

Indicates whether Amazon CloudWatch action based recovery is supported.

Source

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

Indicates whether Amazon CloudWatch action based recovery is supported.

Source

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

Indicates whether Amazon CloudWatch action based recovery is supported.

Source

pub fn supported_boot_modes(self, input: BootModeType) -> Self

Appends an item to supported_boot_modes.

To override the contents of this collection use set_supported_boot_modes.

The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide.

Source

pub fn set_supported_boot_modes(self, input: Option<Vec<BootModeType>>) -> Self

The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide.

Source

pub fn get_supported_boot_modes(&self) -> &Option<Vec<BootModeType>>

The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide.

Source

pub fn nitro_enclaves_support(self, input: NitroEnclavesSupport) -> Self

Indicates whether Nitro Enclaves is supported.

Source

pub fn set_nitro_enclaves_support( self, input: Option<NitroEnclavesSupport>, ) -> Self

Indicates whether Nitro Enclaves is supported.

Source

pub fn get_nitro_enclaves_support(&self) -> &Option<NitroEnclavesSupport>

Indicates whether Nitro Enclaves is supported.

Source

pub fn nitro_tpm_support(self, input: NitroTpmSupport) -> Self

Indicates whether NitroTPM is supported.

Source

pub fn set_nitro_tpm_support(self, input: Option<NitroTpmSupport>) -> Self

Indicates whether NitroTPM is supported.

Source

pub fn get_nitro_tpm_support(&self) -> &Option<NitroTpmSupport>

Indicates whether NitroTPM is supported.

Source

pub fn nitro_tpm_info(self, input: NitroTpmInfo) -> Self

Describes the supported NitroTPM versions for the instance type.

Source

pub fn set_nitro_tpm_info(self, input: Option<NitroTpmInfo>) -> Self

Describes the supported NitroTPM versions for the instance type.

Source

pub fn get_nitro_tpm_info(&self) -> &Option<NitroTpmInfo>

Describes the supported NitroTPM versions for the instance type.

Source

pub fn media_accelerator_info(self, input: MediaAcceleratorInfo) -> Self

Describes the media accelerator settings for the instance type.

Source

pub fn set_media_accelerator_info( self, input: Option<MediaAcceleratorInfo>, ) -> Self

Describes the media accelerator settings for the instance type.

Source

pub fn get_media_accelerator_info(&self) -> &Option<MediaAcceleratorInfo>

Describes the media accelerator settings for the instance type.

Source

pub fn neuron_info(self, input: NeuronInfo) -> Self

Describes the Neuron accelerator settings for the instance type.

Source

pub fn set_neuron_info(self, input: Option<NeuronInfo>) -> Self

Describes the Neuron accelerator settings for the instance type.

Source

pub fn get_neuron_info(&self) -> &Option<NeuronInfo>

Describes the Neuron accelerator settings for the instance type.

Source

pub fn phc_support(self, input: PhcSupport) -> Self

Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported.

Source

pub fn set_phc_support(self, input: Option<PhcSupport>) -> Self

Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported.

Source

pub fn get_phc_support(&self) -> &Option<PhcSupport>

Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported.

Source

pub fn reboot_migration_support(self, input: RebootMigrationSupport) -> Self

Indicates whether reboot migration during a user-initiated reboot is supported for instances that have a scheduled system-reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.

Source

pub fn set_reboot_migration_support( self, input: Option<RebootMigrationSupport>, ) -> Self

Indicates whether reboot migration during a user-initiated reboot is supported for instances that have a scheduled system-reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.

Source

pub fn get_reboot_migration_support(&self) -> &Option<RebootMigrationSupport>

Indicates whether reboot migration during a user-initiated reboot is supported for instances that have a scheduled system-reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.

Source

pub fn build(self) -> InstanceTypeInfo

Consumes the builder and constructs a InstanceTypeInfo.

Trait Implementations§

Source§

impl Clone for InstanceTypeInfoBuilder

Source§

fn clone(&self) -> InstanceTypeInfoBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InstanceTypeInfoBuilder

Source§

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

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

impl Default for InstanceTypeInfoBuilder

Source§

fn default() -> InstanceTypeInfoBuilder

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

impl PartialEq for InstanceTypeInfoBuilder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

const 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 InstanceTypeInfoBuilder

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,