Struct Instance

Source
#[non_exhaustive]
pub struct Instance {
Show 59 fields pub architecture: Option<ArchitectureValues>, pub block_device_mappings: Option<Vec<InstanceBlockDeviceMapping>>, pub client_token: Option<String>, pub ebs_optimized: Option<bool>, pub ena_support: Option<bool>, pub hypervisor: Option<HypervisorType>, pub iam_instance_profile: Option<IamInstanceProfile>, pub instance_lifecycle: Option<InstanceLifecycleType>, pub elastic_gpu_associations: Option<Vec<ElasticGpuAssociation>>, pub elastic_inference_accelerator_associations: Option<Vec<ElasticInferenceAcceleratorAssociation>>, pub network_interfaces: Option<Vec<InstanceNetworkInterface>>, pub outpost_arn: Option<String>, pub root_device_name: Option<String>, pub root_device_type: Option<DeviceType>, pub security_groups: Option<Vec<GroupIdentifier>>, pub source_dest_check: Option<bool>, pub spot_instance_request_id: Option<String>, pub sriov_net_support: Option<String>, pub state_reason: Option<StateReason>, pub tags: Option<Vec<Tag>>, pub virtualization_type: Option<VirtualizationType>, pub cpu_options: Option<CpuOptions>, pub capacity_reservation_id: Option<String>, pub capacity_reservation_specification: Option<CapacityReservationSpecificationResponse>, pub hibernation_options: Option<HibernationOptions>, pub licenses: Option<Vec<LicenseConfiguration>>, pub metadata_options: Option<InstanceMetadataOptionsResponse>, pub enclave_options: Option<EnclaveOptions>, pub boot_mode: Option<BootModeValues>, pub platform_details: Option<String>, pub usage_operation: Option<String>, pub usage_operation_update_time: Option<DateTime>, pub private_dns_name_options: Option<PrivateDnsNameOptionsResponse>, pub ipv6_address: Option<String>, pub tpm_support: Option<String>, pub maintenance_options: Option<InstanceMaintenanceOptions>, pub current_instance_boot_mode: Option<InstanceBootModeValues>, pub network_performance_options: Option<InstanceNetworkPerformanceOptions>, pub operator: Option<OperatorResponse>, pub instance_id: Option<String>, pub image_id: Option<String>, pub state: Option<InstanceState>, pub private_dns_name: Option<String>, pub public_dns_name: Option<String>, pub state_transition_reason: Option<String>, pub key_name: Option<String>, pub ami_launch_index: Option<i32>, pub product_codes: Option<Vec<ProductCode>>, pub instance_type: Option<InstanceType>, pub launch_time: Option<DateTime>, pub placement: Option<Placement>, pub kernel_id: Option<String>, pub ramdisk_id: Option<String>, pub platform: Option<PlatformValues>, pub monitoring: Option<Monitoring>, pub subnet_id: Option<String>, pub vpc_id: Option<String>, pub private_ip_address: Option<String>, pub public_ip_address: Option<String>,
}
Expand description

Describes an instance.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§architecture: Option<ArchitectureValues>

The architecture of the image.

§block_device_mappings: Option<Vec<InstanceBlockDeviceMapping>>

Any block device mapping entries for the instance.

§client_token: Option<String>

The idempotency token you provided when you launched the instance, if applicable.

§ebs_optimized: Option<bool>

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

§ena_support: Option<bool>

Specifies whether enhanced networking with ENA is enabled.

§hypervisor: Option<HypervisorType>

The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.

§iam_instance_profile: Option<IamInstanceProfile>

The IAM instance profile associated with the instance, if applicable.

§instance_lifecycle: Option<InstanceLifecycleType>

Indicates whether this is a Spot Instance or a Scheduled Instance.

§elastic_gpu_associations: Option<Vec<ElasticGpuAssociation>>

Deprecated.

Amazon Elastic Graphics reached end of life on January 8, 2024.

§elastic_inference_accelerator_associations: Option<Vec<ElasticInferenceAcceleratorAssociation>>

Deprecated

Amazon Elastic Inference is no longer available.

§network_interfaces: Option<Vec<InstanceNetworkInterface>>

The network interfaces for the instance.

§outpost_arn: Option<String>

The Amazon Resource Name (ARN) of the Outpost.

§root_device_name: Option<String>

The device name of the root device volume (for example, /dev/sda1).

§root_device_type: Option<DeviceType>

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

§security_groups: Option<Vec<GroupIdentifier>>

The security groups for the instance.

§source_dest_check: Option<bool>

Indicates whether source/destination checking is enabled.

§spot_instance_request_id: Option<String>

If the request is a Spot Instance request, the ID of the request.

§sriov_net_support: Option<String>

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

§state_reason: Option<StateReason>

The reason for the most recent state transition.

§tags: Option<Vec<Tag>>

Any tags assigned to the instance.

§virtualization_type: Option<VirtualizationType>

The virtualization type of the instance.

§cpu_options: Option<CpuOptions>

The CPU options for the instance.

§capacity_reservation_id: Option<String>

The ID of the Capacity Reservation.

§capacity_reservation_specification: Option<CapacityReservationSpecificationResponse>

Information about the Capacity Reservation targeting option.

§hibernation_options: Option<HibernationOptions>

Indicates whether the instance is enabled for hibernation.

§licenses: Option<Vec<LicenseConfiguration>>

The license configurations for the instance.

§metadata_options: Option<InstanceMetadataOptionsResponse>

The metadata options for the instance.

§enclave_options: Option<EnclaveOptions>

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

§boot_mode: Option<BootModeValues>

The boot mode that was specified by the AMI. If the value is uefi-preferred, the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter is the boot mode that is used to boot the instance at launch or start.

The operating system contained in the AMI must be configured to support the specified boot mode.

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

§platform_details: Option<String>

The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

§usage_operation: Option<String>

The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

§usage_operation_update_time: Option<DateTime>

The time that the usage operation was last updated.

§private_dns_name_options: Option<PrivateDnsNameOptionsResponse>

The options for the instance hostname.

§ipv6_address: Option<String>

The IPv6 address assigned to the instance.

§tpm_support: Option<String>

If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

§maintenance_options: Option<InstanceMaintenanceOptions>

Provides information on the recovery and maintenance options of your instance.

§current_instance_boot_mode: Option<InstanceBootModeValues>

The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.

§network_performance_options: Option<InstanceNetworkPerformanceOptions>

Contains settings for the network performance options for your instance.

§operator: Option<OperatorResponse>

The service provider that manages the instance.

§instance_id: Option<String>

The ID of the instance.

§image_id: Option<String>

The ID of the AMI used to launch the instance.

§state: Option<InstanceState>

The current state of the instance.

§private_dns_name: Option<String>

\[IPv4 only\] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

§public_dns_name: Option<String>

\[IPv4 only\] The public DNS name assigned to the instance. This name is not available until the instance enters the running state. This name is only available if you've enabled DNS hostnames for your VPC.

§state_transition_reason: Option<String>

The reason for the most recent state transition. This might be an empty string.

§key_name: Option<String>

The name of the key pair, if this instance was launched with an associated key pair.

§ami_launch_index: Option<i32>

The AMI launch index, which can be used to find this instance in the launch group.

§product_codes: Option<Vec<ProductCode>>

The product codes attached to this instance, if applicable.

§instance_type: Option<InstanceType>

The instance type.

§launch_time: Option<DateTime>

The time that the instance was last launched. To determine the time that instance was first launched, see the attachment time for the primary network interface.

§placement: Option<Placement>

The location where the instance launched, if applicable.

§kernel_id: Option<String>

The kernel associated with this instance, if applicable.

§ramdisk_id: Option<String>

The RAM disk associated with this instance, if applicable.

§platform: Option<PlatformValues>

The platform. This value is windows for Windows instances; otherwise, it is empty.

§monitoring: Option<Monitoring>

The monitoring for the instance.

§subnet_id: Option<String>

The ID of the subnet in which the instance is running.

§vpc_id: Option<String>

The ID of the VPC in which the instance is running.

§private_ip_address: Option<String>

The private IPv4 address assigned to the instance.

§public_ip_address: Option<String>

The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.

A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

Implementations§

Source§

impl Instance

Source

pub fn architecture(&self) -> Option<&ArchitectureValues>

The architecture of the image.

Source

pub fn block_device_mappings(&self) -> &[InstanceBlockDeviceMapping]

Any block device mapping entries for the instance.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .block_device_mappings.is_none().

Source

pub fn client_token(&self) -> Option<&str>

The idempotency token you provided when you launched the instance, if applicable.

Source

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

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Source

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

Specifies whether enhanced networking with ENA is enabled.

Source

pub fn hypervisor(&self) -> Option<&HypervisorType>

The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.

Source

pub fn iam_instance_profile(&self) -> Option<&IamInstanceProfile>

The IAM instance profile associated with the instance, if applicable.

Source

pub fn instance_lifecycle(&self) -> Option<&InstanceLifecycleType>

Indicates whether this is a Spot Instance or a Scheduled Instance.

Source

pub fn elastic_gpu_associations(&self) -> &[ElasticGpuAssociation]

Deprecated.

Amazon Elastic Graphics reached end of life on January 8, 2024.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .elastic_gpu_associations.is_none().

Source

pub fn elastic_inference_accelerator_associations( &self, ) -> &[ElasticInferenceAcceleratorAssociation]

Deprecated

Amazon Elastic Inference is no longer available.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .elastic_inference_accelerator_associations.is_none().

Source

pub fn network_interfaces(&self) -> &[InstanceNetworkInterface]

The network interfaces for the instance.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .network_interfaces.is_none().

Source

pub fn outpost_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the Outpost.

Source

pub fn root_device_name(&self) -> Option<&str>

The device name of the root device volume (for example, /dev/sda1).

Source

pub fn root_device_type(&self) -> Option<&DeviceType>

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

Source

pub fn security_groups(&self) -> &[GroupIdentifier]

The security groups for the instance.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_groups.is_none().

Source

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

Indicates whether source/destination checking is enabled.

Source

pub fn spot_instance_request_id(&self) -> Option<&str>

If the request is a Spot Instance request, the ID of the request.

Source

pub fn sriov_net_support(&self) -> Option<&str>

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Source

pub fn state_reason(&self) -> Option<&StateReason>

The reason for the most recent state transition.

Source

pub fn tags(&self) -> &[Tag]

Any tags assigned to the instance.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

Source

pub fn virtualization_type(&self) -> Option<&VirtualizationType>

The virtualization type of the instance.

Source

pub fn cpu_options(&self) -> Option<&CpuOptions>

The CPU options for the instance.

Source

pub fn capacity_reservation_id(&self) -> Option<&str>

The ID of the Capacity Reservation.

Source

pub fn capacity_reservation_specification( &self, ) -> Option<&CapacityReservationSpecificationResponse>

Information about the Capacity Reservation targeting option.

Source

pub fn hibernation_options(&self) -> Option<&HibernationOptions>

Indicates whether the instance is enabled for hibernation.

Source

pub fn licenses(&self) -> &[LicenseConfiguration]

The license configurations for the instance.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .licenses.is_none().

Source

pub fn metadata_options(&self) -> Option<&InstanceMetadataOptionsResponse>

The metadata options for the instance.

Source

pub fn enclave_options(&self) -> Option<&EnclaveOptions>

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

Source

pub fn boot_mode(&self) -> Option<&BootModeValues>

The boot mode that was specified by the AMI. If the value is uefi-preferred, the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter is the boot mode that is used to boot the instance at launch or start.

The operating system contained in the AMI must be configured to support the specified boot mode.

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

Source

pub fn platform_details(&self) -> Option<&str>

The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

Source

pub fn usage_operation(&self) -> Option<&str>

The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

Source

pub fn usage_operation_update_time(&self) -> Option<&DateTime>

The time that the usage operation was last updated.

Source

pub fn private_dns_name_options(&self) -> Option<&PrivateDnsNameOptionsResponse>

The options for the instance hostname.

Source

pub fn ipv6_address(&self) -> Option<&str>

The IPv6 address assigned to the instance.

Source

pub fn tpm_support(&self) -> Option<&str>

If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

Source

pub fn maintenance_options(&self) -> Option<&InstanceMaintenanceOptions>

Provides information on the recovery and maintenance options of your instance.

Source

pub fn current_instance_boot_mode(&self) -> Option<&InstanceBootModeValues>

The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.

Source

pub fn network_performance_options( &self, ) -> Option<&InstanceNetworkPerformanceOptions>

Contains settings for the network performance options for your instance.

Source

pub fn operator(&self) -> Option<&OperatorResponse>

The service provider that manages the instance.

Source

pub fn instance_id(&self) -> Option<&str>

The ID of the instance.

Source

pub fn image_id(&self) -> Option<&str>

The ID of the AMI used to launch the instance.

Source

pub fn state(&self) -> Option<&InstanceState>

The current state of the instance.

Source

pub fn private_dns_name(&self) -> Option<&str>

\[IPv4 only\] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

Source

pub fn public_dns_name(&self) -> Option<&str>

\[IPv4 only\] The public DNS name assigned to the instance. This name is not available until the instance enters the running state. This name is only available if you've enabled DNS hostnames for your VPC.

Source

pub fn state_transition_reason(&self) -> Option<&str>

The reason for the most recent state transition. This might be an empty string.

Source

pub fn key_name(&self) -> Option<&str>

The name of the key pair, if this instance was launched with an associated key pair.

Source

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

The AMI launch index, which can be used to find this instance in the launch group.

Source

pub fn product_codes(&self) -> &[ProductCode]

The product codes attached to this instance, if applicable.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .product_codes.is_none().

Source

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

The instance type.

Source

pub fn launch_time(&self) -> Option<&DateTime>

The time that the instance was last launched. To determine the time that instance was first launched, see the attachment time for the primary network interface.

Source

pub fn placement(&self) -> Option<&Placement>

The location where the instance launched, if applicable.

Source

pub fn kernel_id(&self) -> Option<&str>

The kernel associated with this instance, if applicable.

Source

pub fn ramdisk_id(&self) -> Option<&str>

The RAM disk associated with this instance, if applicable.

Source

pub fn platform(&self) -> Option<&PlatformValues>

The platform. This value is windows for Windows instances; otherwise, it is empty.

Source

pub fn monitoring(&self) -> Option<&Monitoring>

The monitoring for the instance.

Source

pub fn subnet_id(&self) -> Option<&str>

The ID of the subnet in which the instance is running.

Source

pub fn vpc_id(&self) -> Option<&str>

The ID of the VPC in which the instance is running.

Source

pub fn private_ip_address(&self) -> Option<&str>

The private IPv4 address assigned to the instance.

Source

pub fn public_ip_address(&self) -> Option<&str>

The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.

A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

Source§

impl Instance

Source

pub fn builder() -> InstanceBuilder

Creates a new builder-style object to manufacture Instance.

Trait Implementations§

Source§

impl Clone for Instance

Source§

fn clone(&self) -> Instance

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 Instance

Source§

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

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

impl PartialEq for Instance

Source§

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

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,