#[non_exhaustive]pub struct ModifyInstanceAttributeInputBuilder { /* private fields */ }
Expand description
A builder for ModifyInstanceAttributeInput
.
Implementations§
Source§impl ModifyInstanceAttributeInputBuilder
impl ModifyInstanceAttributeInputBuilder
Sourcepub fn source_dest_check(self, input: AttributeBooleanValue) -> Self
pub fn source_dest_check(self, input: AttributeBooleanValue) -> Self
Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true
, source/destination checks are enabled; otherwise, they are disabled. The default value is true
. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
Sourcepub fn set_source_dest_check(self, input: Option<AttributeBooleanValue>) -> Self
pub fn set_source_dest_check(self, input: Option<AttributeBooleanValue>) -> Self
Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true
, source/destination checks are enabled; otherwise, they are disabled. The default value is true
. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
Sourcepub fn get_source_dest_check(&self) -> &Option<AttributeBooleanValue>
pub fn get_source_dest_check(&self) -> &Option<AttributeBooleanValue>
Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true
, source/destination checks are enabled; otherwise, they are disabled. The default value is true
. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
Sourcepub fn disable_api_stop(self, input: AttributeBooleanValue) -> Self
pub fn disable_api_stop(self, input: AttributeBooleanValue) -> Self
Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance.
Sourcepub fn set_disable_api_stop(self, input: Option<AttributeBooleanValue>) -> Self
pub fn set_disable_api_stop(self, input: Option<AttributeBooleanValue>) -> Self
Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance.
Sourcepub fn get_disable_api_stop(&self) -> &Option<AttributeBooleanValue>
pub fn get_disable_api_stop(&self) -> &Option<AttributeBooleanValue>
Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance.
Sourcepub fn dry_run(self, input: bool) -> Self
pub fn dry_run(self, input: bool) -> Self
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Sourcepub fn set_dry_run(self, input: Option<bool>) -> Self
pub fn set_dry_run(self, input: Option<bool>) -> Self
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Sourcepub fn get_dry_run(&self) -> &Option<bool>
pub fn get_dry_run(&self) -> &Option<bool>
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
The ID of the instance.
This field is required.Sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
The ID of the instance.
Sourcepub fn get_instance_id(&self) -> &Option<String>
pub fn get_instance_id(&self) -> &Option<String>
The ID of the instance.
Sourcepub fn attribute(self, input: InstanceAttributeName) -> Self
pub fn attribute(self, input: InstanceAttributeName) -> Self
The name of the attribute to modify.
When changing the instance type: If the original instance type is configured for configurable bandwidth, and the desired instance type doesn't support configurable bandwidth, first set the existing bandwidth configuration to default
using the ModifyInstanceNetworkPerformanceOptions
operation.
You can modify the following attributes only: disableApiTermination
| instanceType
| kernel
| ramdisk
| instanceInitiatedShutdownBehavior
| blockDeviceMapping
| userData
| sourceDestCheck
| groupSet
| ebsOptimized
| sriovNetSupport
| enaSupport
| nvmeSupport
| disableApiStop
| enclaveOptions
Sourcepub fn set_attribute(self, input: Option<InstanceAttributeName>) -> Self
pub fn set_attribute(self, input: Option<InstanceAttributeName>) -> Self
The name of the attribute to modify.
When changing the instance type: If the original instance type is configured for configurable bandwidth, and the desired instance type doesn't support configurable bandwidth, first set the existing bandwidth configuration to default
using the ModifyInstanceNetworkPerformanceOptions
operation.
You can modify the following attributes only: disableApiTermination
| instanceType
| kernel
| ramdisk
| instanceInitiatedShutdownBehavior
| blockDeviceMapping
| userData
| sourceDestCheck
| groupSet
| ebsOptimized
| sriovNetSupport
| enaSupport
| nvmeSupport
| disableApiStop
| enclaveOptions
Sourcepub fn get_attribute(&self) -> &Option<InstanceAttributeName>
pub fn get_attribute(&self) -> &Option<InstanceAttributeName>
The name of the attribute to modify.
When changing the instance type: If the original instance type is configured for configurable bandwidth, and the desired instance type doesn't support configurable bandwidth, first set the existing bandwidth configuration to default
using the ModifyInstanceNetworkPerformanceOptions
operation.
You can modify the following attributes only: disableApiTermination
| instanceType
| kernel
| ramdisk
| instanceInitiatedShutdownBehavior
| blockDeviceMapping
| userData
| sourceDestCheck
| groupSet
| ebsOptimized
| sriovNetSupport
| enaSupport
| nvmeSupport
| disableApiStop
| enclaveOptions
Sourcepub fn value(self, input: impl Into<String>) -> Self
pub fn value(self, input: impl Into<String>) -> Self
A new value for the attribute. Use only with the kernel
, ramdisk
, userData
, disableApiTermination
, or instanceInitiatedShutdownBehavior
attribute.
Sourcepub fn set_value(self, input: Option<String>) -> Self
pub fn set_value(self, input: Option<String>) -> Self
A new value for the attribute. Use only with the kernel
, ramdisk
, userData
, disableApiTermination
, or instanceInitiatedShutdownBehavior
attribute.
Sourcepub fn get_value(&self) -> &Option<String>
pub fn get_value(&self) -> &Option<String>
A new value for the attribute. Use only with the kernel
, ramdisk
, userData
, disableApiTermination
, or instanceInitiatedShutdownBehavior
attribute.
Sourcepub fn block_device_mappings(
self,
input: InstanceBlockDeviceMappingSpecification,
) -> Self
pub fn block_device_mappings( self, input: InstanceBlockDeviceMappingSpecification, ) -> Self
Appends an item to block_device_mappings
.
To override the contents of this collection use set_block_device_mappings
.
Modifies the DeleteOnTermination
attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination
, the default is true
and the volume is deleted when the instance is terminated. You can't modify the DeleteOnTermination
attribute for volumes that are attached to Amazon Web Services-managed resources.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
Sourcepub fn set_block_device_mappings(
self,
input: Option<Vec<InstanceBlockDeviceMappingSpecification>>,
) -> Self
pub fn set_block_device_mappings( self, input: Option<Vec<InstanceBlockDeviceMappingSpecification>>, ) -> Self
Modifies the DeleteOnTermination
attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination
, the default is true
and the volume is deleted when the instance is terminated. You can't modify the DeleteOnTermination
attribute for volumes that are attached to Amazon Web Services-managed resources.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
Sourcepub fn get_block_device_mappings(
&self,
) -> &Option<Vec<InstanceBlockDeviceMappingSpecification>>
pub fn get_block_device_mappings( &self, ) -> &Option<Vec<InstanceBlockDeviceMappingSpecification>>
Modifies the DeleteOnTermination
attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination
, the default is true
and the volume is deleted when the instance is terminated. You can't modify the DeleteOnTermination
attribute for volumes that are attached to Amazon Web Services-managed resources.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
Sourcepub fn disable_api_termination(self, input: AttributeBooleanValue) -> Self
pub fn disable_api_termination(self, input: AttributeBooleanValue) -> Self
Enable or disable termination protection for the instance. If the value is true
, you can't terminate the instance using the Amazon EC2 console, command line interface, or API. You can't enable termination protection for Spot Instances.
Sourcepub fn set_disable_api_termination(
self,
input: Option<AttributeBooleanValue>,
) -> Self
pub fn set_disable_api_termination( self, input: Option<AttributeBooleanValue>, ) -> Self
Enable or disable termination protection for the instance. If the value is true
, you can't terminate the instance using the Amazon EC2 console, command line interface, or API. You can't enable termination protection for Spot Instances.
Sourcepub fn get_disable_api_termination(&self) -> &Option<AttributeBooleanValue>
pub fn get_disable_api_termination(&self) -> &Option<AttributeBooleanValue>
Enable or disable termination protection for the instance. If the value is true
, you can't terminate the instance using the Amazon EC2 console, command line interface, or API. You can't enable termination protection for Spot Instances.
Sourcepub fn instance_type(self, input: AttributeValue) -> Self
pub fn instance_type(self, input: AttributeValue) -> Self
Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue
.
Sourcepub fn set_instance_type(self, input: Option<AttributeValue>) -> Self
pub fn set_instance_type(self, input: Option<AttributeValue>) -> Self
Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue
.
Sourcepub fn get_instance_type(&self) -> &Option<AttributeValue>
pub fn get_instance_type(&self) -> &Option<AttributeValue>
Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue
.
Sourcepub fn kernel(self, input: AttributeValue) -> Self
pub fn kernel(self, input: AttributeValue) -> Self
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
Sourcepub fn set_kernel(self, input: Option<AttributeValue>) -> Self
pub fn set_kernel(self, input: Option<AttributeValue>) -> Self
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
Sourcepub fn get_kernel(&self) -> &Option<AttributeValue>
pub fn get_kernel(&self) -> &Option<AttributeValue>
Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
Sourcepub fn ramdisk(self, input: AttributeValue) -> Self
pub fn ramdisk(self, input: AttributeValue) -> Self
Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
Sourcepub fn set_ramdisk(self, input: Option<AttributeValue>) -> Self
pub fn set_ramdisk(self, input: Option<AttributeValue>) -> Self
Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
Sourcepub fn get_ramdisk(&self) -> &Option<AttributeValue>
pub fn get_ramdisk(&self) -> &Option<AttributeValue>
Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
Sourcepub fn user_data(self, input: BlobAttributeValue) -> Self
pub fn user_data(self, input: BlobAttributeValue) -> Self
Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data.
Sourcepub fn set_user_data(self, input: Option<BlobAttributeValue>) -> Self
pub fn set_user_data(self, input: Option<BlobAttributeValue>) -> Self
Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data.
Sourcepub fn get_user_data(&self) -> &Option<BlobAttributeValue>
pub fn get_user_data(&self) -> &Option<BlobAttributeValue>
Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data.
Sourcepub fn instance_initiated_shutdown_behavior(self, input: AttributeValue) -> Self
pub fn instance_initiated_shutdown_behavior(self, input: AttributeValue) -> Self
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Sourcepub fn set_instance_initiated_shutdown_behavior(
self,
input: Option<AttributeValue>,
) -> Self
pub fn set_instance_initiated_shutdown_behavior( self, input: Option<AttributeValue>, ) -> Self
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Sourcepub fn get_instance_initiated_shutdown_behavior(
&self,
) -> &Option<AttributeValue>
pub fn get_instance_initiated_shutdown_behavior( &self, ) -> &Option<AttributeValue>
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Sourcepub fn groups(self, input: impl Into<String>) -> Self
pub fn groups(self, input: impl Into<String>) -> Self
Appends an item to groups
.
To override the contents of this collection use set_groups
.
Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it's just the default security group for the VPC.
Sourcepub fn set_groups(self, input: Option<Vec<String>>) -> Self
pub fn set_groups(self, input: Option<Vec<String>>) -> Self
Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it's just the default security group for the VPC.
Sourcepub fn get_groups(&self) -> &Option<Vec<String>>
pub fn get_groups(&self) -> &Option<Vec<String>>
Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it's just the default security group for the VPC.
Sourcepub fn ebs_optimized(self, input: AttributeBooleanValue) -> Self
pub fn ebs_optimized(self, input: AttributeBooleanValue) -> Self
Specifies 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 EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Sourcepub fn set_ebs_optimized(self, input: Option<AttributeBooleanValue>) -> Self
pub fn set_ebs_optimized(self, input: Option<AttributeBooleanValue>) -> Self
Specifies 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 EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Sourcepub fn get_ebs_optimized(&self) -> &Option<AttributeBooleanValue>
pub fn get_ebs_optimized(&self) -> &Option<AttributeBooleanValue>
Specifies 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 EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Sourcepub fn sriov_net_support(self, input: AttributeValue) -> Self
pub fn sriov_net_support(self, input: AttributeValue) -> Self
Set to simple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
Sourcepub fn set_sriov_net_support(self, input: Option<AttributeValue>) -> Self
pub fn set_sriov_net_support(self, input: Option<AttributeValue>) -> Self
Set to simple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
Sourcepub fn get_sriov_net_support(&self) -> &Option<AttributeValue>
pub fn get_sriov_net_support(&self) -> &Option<AttributeValue>
Set to simple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
Sourcepub fn ena_support(self, input: AttributeBooleanValue) -> Self
pub fn ena_support(self, input: AttributeBooleanValue) -> Self
Set to true
to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
Sourcepub fn set_ena_support(self, input: Option<AttributeBooleanValue>) -> Self
pub fn set_ena_support(self, input: Option<AttributeBooleanValue>) -> Self
Set to true
to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
Sourcepub fn get_ena_support(&self) -> &Option<AttributeBooleanValue>
pub fn get_ena_support(&self) -> &Option<AttributeBooleanValue>
Set to true
to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
Sourcepub fn build(self) -> Result<ModifyInstanceAttributeInput, BuildError>
pub fn build(self) -> Result<ModifyInstanceAttributeInput, BuildError>
Consumes the builder and constructs a ModifyInstanceAttributeInput
.
Source§impl ModifyInstanceAttributeInputBuilder
impl ModifyInstanceAttributeInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<ModifyInstanceAttributeOutput, SdkError<ModifyInstanceAttributeError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<ModifyInstanceAttributeOutput, SdkError<ModifyInstanceAttributeError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for ModifyInstanceAttributeInputBuilder
impl Clone for ModifyInstanceAttributeInputBuilder
Source§fn clone(&self) -> ModifyInstanceAttributeInputBuilder
fn clone(&self) -> ModifyInstanceAttributeInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for ModifyInstanceAttributeInputBuilder
impl Default for ModifyInstanceAttributeInputBuilder
Source§fn default() -> ModifyInstanceAttributeInputBuilder
fn default() -> ModifyInstanceAttributeInputBuilder
Source§impl PartialEq for ModifyInstanceAttributeInputBuilder
impl PartialEq for ModifyInstanceAttributeInputBuilder
Source§fn eq(&self, other: &ModifyInstanceAttributeInputBuilder) -> bool
fn eq(&self, other: &ModifyInstanceAttributeInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ModifyInstanceAttributeInputBuilder
Auto Trait Implementations§
impl Freeze for ModifyInstanceAttributeInputBuilder
impl RefUnwindSafe for ModifyInstanceAttributeInputBuilder
impl Send for ModifyInstanceAttributeInputBuilder
impl Sync for ModifyInstanceAttributeInputBuilder
impl Unpin for ModifyInstanceAttributeInputBuilder
impl UnwindSafe for ModifyInstanceAttributeInputBuilder
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);