AwsEc2LaunchTemplateDataDetailsBuilder

aws_sdk_securityhub::types::builders

Struct AwsEc2LaunchTemplateDataDetailsBuilder 

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

A builder for AwsEc2LaunchTemplateDataDetails.

Implementations§

Source§

impl AwsEc2LaunchTemplateDataDetailsBuilder

Source

pub fn block_device_mapping_set( self, input: AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails, ) -> Self

Appends an item to block_device_mapping_set.

To override the contents of this collection use set_block_device_mapping_set.

Information about a block device mapping for an Amazon EC2 launch template.

Source

pub fn set_block_device_mapping_set( self, input: Option<Vec<AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails>>, ) -> Self

Information about a block device mapping for an Amazon EC2 launch template.

Source

pub fn get_block_device_mapping_set( &self, ) -> &Option<Vec<AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails>>

Information about a block device mapping for an Amazon EC2 launch template.

Source

pub fn capacity_reservation_specification( self, input: AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails, ) -> Self

Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.

Source

pub fn set_capacity_reservation_specification( self, input: Option<AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails>, ) -> Self

Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.

Source

pub fn get_capacity_reservation_specification( &self, ) -> &Option<AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails>

Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.

Source

pub fn cpu_options( self, input: AwsEc2LaunchTemplateDataCpuOptionsDetails, ) -> Self

Specifies the CPU options for an instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.

Source

pub fn set_cpu_options( self, input: Option<AwsEc2LaunchTemplateDataCpuOptionsDetails>, ) -> Self

Specifies the CPU options for an instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.

Source

pub fn get_cpu_options( &self, ) -> &Option<AwsEc2LaunchTemplateDataCpuOptionsDetails>

Specifies the CPU options for an instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.

Source

pub fn credit_specification( self, input: AwsEc2LaunchTemplateDataCreditSpecificationDetails, ) -> Self

Specifies the credit option for CPU usage of a T2, T3, or T3a instance.

Source

pub fn set_credit_specification( self, input: Option<AwsEc2LaunchTemplateDataCreditSpecificationDetails>, ) -> Self

Specifies the credit option for CPU usage of a T2, T3, or T3a instance.

Source

pub fn get_credit_specification( &self, ) -> &Option<AwsEc2LaunchTemplateDataCreditSpecificationDetails>

Specifies the credit option for CPU usage of a T2, T3, or T3a instance.

Source

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

Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection in the Amazon EC2 User Guide.

Source

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

Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection in the Amazon EC2 User Guide.

Source

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

Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection in the Amazon EC2 User Guide.

Source

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

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. If set to true, you can.

Source

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

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. If set to true, you can.

Source

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

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. If set to true, you can.

Source

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

Indicates whether the instance is optimized for Amazon EBS I/O.

Source

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

Indicates whether the instance is optimized for Amazon EBS I/O.

Source

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

Indicates whether the instance is optimized for Amazon EBS I/O.

Source

pub fn elastic_gpu_specification_set( self, input: AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails, ) -> Self

Appends an item to elastic_gpu_specification_set.

To override the contents of this collection use set_elastic_gpu_specification_set.

Provides details about Elastic Graphics accelerators to associate with the instance.

Source

pub fn set_elastic_gpu_specification_set( self, input: Option<Vec<AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails>>, ) -> Self

Provides details about Elastic Graphics accelerators to associate with the instance.

Source

pub fn get_elastic_gpu_specification_set( &self, ) -> &Option<Vec<AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails>>

Provides details about Elastic Graphics accelerators to associate with the instance.

Source

pub fn elastic_inference_accelerator_set( self, input: AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails, ) -> Self

Appends an item to elastic_inference_accelerator_set.

To override the contents of this collection use set_elastic_inference_accelerator_set.

The Amazon Elastic Inference accelerator for the instance.

Source

pub fn set_elastic_inference_accelerator_set( self, input: Option<Vec<AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails>>, ) -> Self

The Amazon Elastic Inference accelerator for the instance.

Source

pub fn get_elastic_inference_accelerator_set( &self, ) -> &Option<Vec<AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails>>

The Amazon Elastic Inference accelerator for the instance.

Source

pub fn enclave_options( self, input: AwsEc2LaunchTemplateDataEnclaveOptionsDetails, ) -> Self

Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.

Source

pub fn set_enclave_options( self, input: Option<AwsEc2LaunchTemplateDataEnclaveOptionsDetails>, ) -> Self

Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.

Source

pub fn get_enclave_options( &self, ) -> &Option<AwsEc2LaunchTemplateDataEnclaveOptionsDetails>

Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.

Source

pub fn hibernation_options( self, input: AwsEc2LaunchTemplateDataHibernationOptionsDetails, ) -> Self

Specifies whether your Amazon EC2 instance is configured for hibernation.

Source

pub fn set_hibernation_options( self, input: Option<AwsEc2LaunchTemplateDataHibernationOptionsDetails>, ) -> Self

Specifies whether your Amazon EC2 instance is configured for hibernation.

Source

pub fn get_hibernation_options( &self, ) -> &Option<AwsEc2LaunchTemplateDataHibernationOptionsDetails>

Specifies whether your Amazon EC2 instance is configured for hibernation.

Source

pub fn iam_instance_profile( self, input: AwsEc2LaunchTemplateDataIamInstanceProfileDetails, ) -> Self

The name or Amazon Resource Name (ARN) of an IAM instance profile.

Source

pub fn set_iam_instance_profile( self, input: Option<AwsEc2LaunchTemplateDataIamInstanceProfileDetails>, ) -> Self

The name or Amazon Resource Name (ARN) of an IAM instance profile.

Source

pub fn get_iam_instance_profile( &self, ) -> &Option<AwsEc2LaunchTemplateDataIamInstanceProfileDetails>

The name or Amazon Resource Name (ARN) of an IAM instance profile.

Source

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

The ID of the Amazon Machine Image (AMI).

Source

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

The ID of the Amazon Machine Image (AMI).

Source

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

The ID of the Amazon Machine Image (AMI).

Source

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

Provides the options for specifying the instance initiated shutdown behavior.

Source

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

Provides the options for specifying the instance initiated shutdown behavior.

Source

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

Provides the options for specifying the instance initiated shutdown behavior.

Source

pub fn instance_market_options( self, input: AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails, ) -> Self

Specifies the market (purchasing) option for an instance.

Source

pub fn set_instance_market_options( self, input: Option<AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails>, ) -> Self

Specifies the market (purchasing) option for an instance.

Source

pub fn get_instance_market_options( &self, ) -> &Option<AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails>

Specifies the market (purchasing) option for an instance.

Source

pub fn instance_requirements( self, input: AwsEc2LaunchTemplateDataInstanceRequirementsDetails, ) -> Self

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. If you specify InstanceRequirements, you can't specify InstanceType.

Source

pub fn set_instance_requirements( self, input: Option<AwsEc2LaunchTemplateDataInstanceRequirementsDetails>, ) -> Self

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. If you specify InstanceRequirements, you can't specify InstanceType.

Source

pub fn get_instance_requirements( &self, ) -> &Option<AwsEc2LaunchTemplateDataInstanceRequirementsDetails>

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. If you specify InstanceRequirements, you can't specify InstanceType.

Source

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

The instance type. For more information, see Instance types in the Amazon EC2 User Guide. If you specify InstanceType, you can't specify InstanceRequirements.

Source

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

The instance type. For more information, see Instance types in the Amazon EC2 User Guide. If you specify InstanceType, you can't specify InstanceRequirements.

Source

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

The instance type. For more information, see Instance types in the Amazon EC2 User Guide. If you specify InstanceType, you can't specify InstanceRequirements.

Source

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

The ID of the kernel.

Source

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

The ID of the kernel.

Source

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

The ID of the kernel.

Source

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

The name of the key pair that allows users to connect to the instance.

Source

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

The name of the key pair that allows users to connect to the instance.

Source

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

The name of the key pair that allows users to connect to the instance.

Source

pub fn license_set( self, input: AwsEc2LaunchTemplateDataLicenseSetDetails, ) -> Self

Appends an item to license_set.

To override the contents of this collection use set_license_set.

Specifies a license configuration for an instance.

Source

pub fn set_license_set( self, input: Option<Vec<AwsEc2LaunchTemplateDataLicenseSetDetails>>, ) -> Self

Specifies a license configuration for an instance.

Source

pub fn get_license_set( &self, ) -> &Option<Vec<AwsEc2LaunchTemplateDataLicenseSetDetails>>

Specifies a license configuration for an instance.

Source

pub fn maintenance_options( self, input: AwsEc2LaunchTemplateDataMaintenanceOptionsDetails, ) -> Self

The maintenance options of your instance.

Source

pub fn set_maintenance_options( self, input: Option<AwsEc2LaunchTemplateDataMaintenanceOptionsDetails>, ) -> Self

The maintenance options of your instance.

Source

pub fn get_maintenance_options( &self, ) -> &Option<AwsEc2LaunchTemplateDataMaintenanceOptionsDetails>

The maintenance options of your instance.

Source

pub fn metadata_options( self, input: AwsEc2LaunchTemplateDataMetadataOptionsDetails, ) -> Self

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

Source

pub fn set_metadata_options( self, input: Option<AwsEc2LaunchTemplateDataMetadataOptionsDetails>, ) -> Self

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

Source

pub fn get_metadata_options( &self, ) -> &Option<AwsEc2LaunchTemplateDataMetadataOptionsDetails>

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.

Source

pub fn monitoring( self, input: AwsEc2LaunchTemplateDataMonitoringDetails, ) -> Self

The monitoring for the instance.

Source

pub fn set_monitoring( self, input: Option<AwsEc2LaunchTemplateDataMonitoringDetails>, ) -> Self

The monitoring for the instance.

Source

pub fn get_monitoring( &self, ) -> &Option<AwsEc2LaunchTemplateDataMonitoringDetails>

The monitoring for the instance.

Source

pub fn network_interface_set( self, input: AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails, ) -> Self

Appends an item to network_interface_set.

To override the contents of this collection use set_network_interface_set.

Specifies the parameters for a network interface that is attached to the instance.

Source

pub fn set_network_interface_set( self, input: Option<Vec<AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails>>, ) -> Self

Specifies the parameters for a network interface that is attached to the instance.

Source

pub fn get_network_interface_set( &self, ) -> &Option<Vec<AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails>>

Specifies the parameters for a network interface that is attached to the instance.

Source

pub fn placement(self, input: AwsEc2LaunchTemplateDataPlacementDetails) -> Self

Specifies the placement of an instance.

Source

pub fn set_placement( self, input: Option<AwsEc2LaunchTemplateDataPlacementDetails>, ) -> Self

Specifies the placement of an instance.

Source

pub fn get_placement(&self) -> &Option<AwsEc2LaunchTemplateDataPlacementDetails>

Specifies the placement of an instance.

Source

pub fn private_dns_name_options( self, input: AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails, ) -> Self

The options for the instance hostname.

Source

pub fn set_private_dns_name_options( self, input: Option<AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails>, ) -> Self

The options for the instance hostname.

Source

pub fn get_private_dns_name_options( &self, ) -> &Option<AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails>

The options for the instance hostname.

Source

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

The ID of the RAM disk.

Source

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

The ID of the RAM disk.

Source

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

The ID of the RAM disk.

Source

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

Appends an item to security_group_id_set.

To override the contents of this collection use set_security_group_id_set.

One or more security group IDs.

Source

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

One or more security group IDs.

Source

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

One or more security group IDs.

Source

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

Appends an item to security_group_set.

To override the contents of this collection use set_security_group_set.

One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

Source

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

One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

Source

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

One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

Source

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

The user data to make available to the instance.

Source

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

The user data to make available to the instance.

Source

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

The user data to make available to the instance.

Source

pub fn build(self) -> AwsEc2LaunchTemplateDataDetails

Consumes the builder and constructs a AwsEc2LaunchTemplateDataDetails.

Trait Implementations§

Source§

impl Clone for AwsEc2LaunchTemplateDataDetailsBuilder

Source§

fn clone(&self) -> AwsEc2LaunchTemplateDataDetailsBuilder

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 AwsEc2LaunchTemplateDataDetailsBuilder

Source§

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

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

impl Default for AwsEc2LaunchTemplateDataDetailsBuilder

Source§

fn default() -> AwsEc2LaunchTemplateDataDetailsBuilder

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

impl PartialEq for AwsEc2LaunchTemplateDataDetailsBuilder

Source§

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

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,