#[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
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.
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
impl Instance
Sourcepub fn architecture(&self) -> Option<&ArchitectureValues>
pub fn architecture(&self) -> Option<&ArchitectureValues>
The architecture of the image.
Sourcepub fn block_device_mappings(&self) -> &[InstanceBlockDeviceMapping]
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()
.
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
The idempotency token you provided when you launched the instance, if applicable.
Sourcepub fn ebs_optimized(&self) -> Option<bool>
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.
Sourcepub fn ena_support(&self) -> Option<bool>
pub fn ena_support(&self) -> Option<bool>
Specifies whether enhanced networking with ENA is enabled.
Sourcepub fn hypervisor(&self) -> Option<&HypervisorType>
pub fn hypervisor(&self) -> Option<&HypervisorType>
The hypervisor type of the instance. The value xen
is used for both Xen and Nitro hypervisors.
Sourcepub fn iam_instance_profile(&self) -> Option<&IamInstanceProfile>
pub fn iam_instance_profile(&self) -> Option<&IamInstanceProfile>
The IAM instance profile associated with the instance, if applicable.
Sourcepub fn instance_lifecycle(&self) -> Option<&InstanceLifecycleType>
pub fn instance_lifecycle(&self) -> Option<&InstanceLifecycleType>
Indicates whether this is a Spot Instance or a Scheduled Instance.
Sourcepub fn elastic_gpu_associations(&self) -> &[ElasticGpuAssociation]
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()
.
Sourcepub fn elastic_inference_accelerator_associations(
&self,
) -> &[ElasticInferenceAcceleratorAssociation]
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()
.
Sourcepub fn network_interfaces(&self) -> &[InstanceNetworkInterface]
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()
.
Sourcepub fn outpost_arn(&self) -> Option<&str>
pub fn outpost_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the Outpost.
Sourcepub fn root_device_name(&self) -> Option<&str>
pub fn root_device_name(&self) -> Option<&str>
The device name of the root device volume (for example, /dev/sda1
).
Sourcepub fn root_device_type(&self) -> Option<&DeviceType>
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.
Sourcepub fn security_groups(&self) -> &[GroupIdentifier]
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()
.
Sourcepub fn source_dest_check(&self) -> Option<bool>
pub fn source_dest_check(&self) -> Option<bool>
Indicates whether source/destination checking is enabled.
Sourcepub fn spot_instance_request_id(&self) -> Option<&str>
pub fn spot_instance_request_id(&self) -> Option<&str>
If the request is a Spot Instance request, the ID of the request.
Sourcepub fn sriov_net_support(&self) -> Option<&str>
pub fn sriov_net_support(&self) -> Option<&str>
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
Sourcepub fn state_reason(&self) -> Option<&StateReason>
pub fn state_reason(&self) -> Option<&StateReason>
The reason for the most recent state transition.
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()
.
Sourcepub fn virtualization_type(&self) -> Option<&VirtualizationType>
pub fn virtualization_type(&self) -> Option<&VirtualizationType>
The virtualization type of the instance.
Sourcepub fn cpu_options(&self) -> Option<&CpuOptions>
pub fn cpu_options(&self) -> Option<&CpuOptions>
The CPU options for the instance.
Sourcepub fn capacity_reservation_id(&self) -> Option<&str>
pub fn capacity_reservation_id(&self) -> Option<&str>
The ID of the Capacity Reservation.
Sourcepub fn capacity_reservation_specification(
&self,
) -> Option<&CapacityReservationSpecificationResponse>
pub fn capacity_reservation_specification( &self, ) -> Option<&CapacityReservationSpecificationResponse>
Information about the Capacity Reservation targeting option.
Sourcepub fn hibernation_options(&self) -> Option<&HibernationOptions>
pub fn hibernation_options(&self) -> Option<&HibernationOptions>
Indicates whether the instance is enabled for hibernation.
Sourcepub fn licenses(&self) -> &[LicenseConfiguration]
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()
.
Sourcepub fn metadata_options(&self) -> Option<&InstanceMetadataOptionsResponse>
pub fn metadata_options(&self) -> Option<&InstanceMetadataOptionsResponse>
The metadata options for the instance.
Sourcepub fn enclave_options(&self) -> Option<&EnclaveOptions>
pub fn enclave_options(&self) -> Option<&EnclaveOptions>
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
Sourcepub fn boot_mode(&self) -> Option<&BootModeValues>
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.
Sourcepub fn platform_details(&self) -> Option<&str>
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.
Sourcepub fn usage_operation(&self) -> Option<&str>
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.
Sourcepub fn usage_operation_update_time(&self) -> Option<&DateTime>
pub fn usage_operation_update_time(&self) -> Option<&DateTime>
The time that the usage operation was last updated.
Sourcepub fn private_dns_name_options(&self) -> Option<&PrivateDnsNameOptionsResponse>
pub fn private_dns_name_options(&self) -> Option<&PrivateDnsNameOptionsResponse>
The options for the instance hostname.
Sourcepub fn ipv6_address(&self) -> Option<&str>
pub fn ipv6_address(&self) -> Option<&str>
The IPv6 address assigned to the instance.
Sourcepub fn tpm_support(&self) -> Option<&str>
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.
Sourcepub fn maintenance_options(&self) -> Option<&InstanceMaintenanceOptions>
pub fn maintenance_options(&self) -> Option<&InstanceMaintenanceOptions>
Provides information on the recovery and maintenance options of your instance.
Sourcepub fn current_instance_boot_mode(&self) -> Option<&InstanceBootModeValues>
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.
Sourcepub fn network_performance_options(
&self,
) -> Option<&InstanceNetworkPerformanceOptions>
pub fn network_performance_options( &self, ) -> Option<&InstanceNetworkPerformanceOptions>
Contains settings for the network performance options for your instance.
Sourcepub fn operator(&self) -> Option<&OperatorResponse>
pub fn operator(&self) -> Option<&OperatorResponse>
The service provider that manages the instance.
Sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The ID of the instance.
Sourcepub fn state(&self) -> Option<&InstanceState>
pub fn state(&self) -> Option<&InstanceState>
The current state of the instance.
Sourcepub fn private_dns_name(&self) -> Option<&str>
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.
Sourcepub fn public_dns_name(&self) -> Option<&str>
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.
Sourcepub fn state_transition_reason(&self) -> Option<&str>
pub fn state_transition_reason(&self) -> Option<&str>
The reason for the most recent state transition. This might be an empty string.
Sourcepub fn key_name(&self) -> Option<&str>
pub fn key_name(&self) -> Option<&str>
The name of the key pair, if this instance was launched with an associated key pair.
Sourcepub fn ami_launch_index(&self) -> Option<i32>
pub fn ami_launch_index(&self) -> Option<i32>
The AMI launch index, which can be used to find this instance in the launch group.
Sourcepub fn product_codes(&self) -> &[ProductCode]
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()
.
Sourcepub fn instance_type(&self) -> Option<&InstanceType>
pub fn instance_type(&self) -> Option<&InstanceType>
The instance type.
Sourcepub fn launch_time(&self) -> Option<&DateTime>
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.
Sourcepub fn placement(&self) -> Option<&Placement>
pub fn placement(&self) -> Option<&Placement>
The location where the instance launched, if applicable.
Sourcepub fn kernel_id(&self) -> Option<&str>
pub fn kernel_id(&self) -> Option<&str>
The kernel associated with this instance, if applicable.
Sourcepub fn ramdisk_id(&self) -> Option<&str>
pub fn ramdisk_id(&self) -> Option<&str>
The RAM disk associated with this instance, if applicable.
Sourcepub fn platform(&self) -> Option<&PlatformValues>
pub fn platform(&self) -> Option<&PlatformValues>
The platform. This value is windows
for Windows instances; otherwise, it is empty.
Sourcepub fn monitoring(&self) -> Option<&Monitoring>
pub fn monitoring(&self) -> Option<&Monitoring>
The monitoring for the instance.
Sourcepub fn private_ip_address(&self) -> Option<&str>
pub fn private_ip_address(&self) -> Option<&str>
The private IPv4 address assigned to the instance.
Sourcepub fn public_ip_address(&self) -> Option<&str>
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.
Trait Implementations§
impl StructuralPartialEq for Instance
Auto Trait Implementations§
impl Freeze for Instance
impl RefUnwindSafe for Instance
impl Send for Instance
impl Sync for Instance
impl Unpin for Instance
impl UnwindSafe for Instance
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
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 bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
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>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
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 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.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
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);