pub struct CreateInstanceFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateInstance
.
Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
Implementations§
Source§impl CreateInstanceFluentBuilder
impl CreateInstanceFluentBuilder
Sourcepub fn as_input(&self) -> &CreateInstanceInputBuilder
pub fn as_input(&self) -> &CreateInstanceInputBuilder
Access the CreateInstance as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateInstanceOutput, SdkError<CreateInstanceError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateInstanceOutput, SdkError<CreateInstanceError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateInstanceOutput, CreateInstanceError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateInstanceOutput, CreateInstanceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn set_stack_id(self, input: Option<String>) -> Self
pub fn set_stack_id(self, input: Option<String>) -> Self
The stack ID.
Sourcepub fn get_stack_id(&self) -> &Option<String>
pub fn get_stack_id(&self) -> &Option<String>
The stack ID.
Sourcepub fn layer_ids(self, input: impl Into<String>) -> Self
pub fn layer_ids(self, input: impl Into<String>) -> Self
Appends an item to LayerIds
.
To override the contents of this collection use set_layer_ids
.
An array that contains the instance's layer IDs.
Sourcepub fn set_layer_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_layer_ids(self, input: Option<Vec<String>>) -> Self
An array that contains the instance's layer IDs.
Sourcepub fn get_layer_ids(&self) -> &Option<Vec<String>>
pub fn get_layer_ids(&self) -> &Option<Vec<String>>
An array that contains the instance's layer IDs.
Sourcepub fn instance_type(self, input: impl Into<String>) -> Self
pub fn instance_type(self, input: impl Into<String>) -> Self
The instance type, such as t2.micro
. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
Sourcepub fn set_instance_type(self, input: Option<String>) -> Self
pub fn set_instance_type(self, input: Option<String>) -> Self
The instance type, such as t2.micro
. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
Sourcepub fn get_instance_type(&self) -> &Option<String>
pub fn get_instance_type(&self) -> &Option<String>
The instance type, such as t2.micro
. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.
Sourcepub fn auto_scaling_type(self, input: AutoScalingType) -> Self
pub fn auto_scaling_type(self, input: AutoScalingType) -> Self
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
Sourcepub fn set_auto_scaling_type(self, input: Option<AutoScalingType>) -> Self
pub fn set_auto_scaling_type(self, input: Option<AutoScalingType>) -> Self
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
Sourcepub fn get_auto_scaling_type(&self) -> &Option<AutoScalingType>
pub fn get_auto_scaling_type(&self) -> &Option<AutoScalingType>
For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
Sourcepub fn hostname(self, input: impl Into<String>) -> Self
pub fn hostname(self, input: impl Into<String>) -> Self
The instance host name. The following are character limits for instance host names.
-
Linux-based instances: 63 characters
-
Windows-based instances: 15 characters
Sourcepub fn set_hostname(self, input: Option<String>) -> Self
pub fn set_hostname(self, input: Option<String>) -> Self
The instance host name. The following are character limits for instance host names.
-
Linux-based instances: 63 characters
-
Windows-based instances: 15 characters
Sourcepub fn get_hostname(&self) -> &Option<String>
pub fn get_hostname(&self) -> &Option<String>
The instance host name. The following are character limits for instance host names.
-
Linux-based instances: 63 characters
-
Windows-based instances: 15 characters
Sourcepub fn os(self, input: impl Into<String>) -> Self
pub fn os(self, input: impl Into<String>) -> Self
The instance's operating system, which must be set to one of the following.
-
A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2
,Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. -
A supported Ubuntu operating system, such as
Ubuntu 18.04 LTS
,Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. -
CentOS Linux 7
-
Red Hat Enterprise Linux 7
-
A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
. -
A custom AMI:
Custom
.
Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom
, you must use the CreateInstance
action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom
. For more information about how to use custom AMIs with OpsWorks Stacks, see Using Custom AMIs.
Sourcepub fn set_os(self, input: Option<String>) -> Self
pub fn set_os(self, input: Option<String>) -> Self
The instance's operating system, which must be set to one of the following.
-
A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2
,Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. -
A supported Ubuntu operating system, such as
Ubuntu 18.04 LTS
,Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. -
CentOS Linux 7
-
Red Hat Enterprise Linux 7
-
A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
. -
A custom AMI:
Custom
.
Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom
, you must use the CreateInstance
action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom
. For more information about how to use custom AMIs with OpsWorks Stacks, see Using Custom AMIs.
Sourcepub fn get_os(&self) -> &Option<String>
pub fn get_os(&self) -> &Option<String>
The instance's operating system, which must be set to one of the following.
-
A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2
,Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. -
A supported Ubuntu operating system, such as
Ubuntu 18.04 LTS
,Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. -
CentOS Linux 7
-
Red Hat Enterprise Linux 7
-
A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
. -
A custom AMI:
Custom
.
Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this parameter to Custom
, you must use the CreateInstance
action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom
. For more information about how to use custom AMIs with OpsWorks Stacks, see Using Custom AMIs.
Sourcepub fn ami_id(self, input: impl Into<String>) -> Self
pub fn ami_id(self, input: impl Into<String>) -> Self
A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.
If you specify a custom AMI, you must set Os
to Custom
.
Sourcepub fn set_ami_id(self, input: Option<String>) -> Self
pub fn set_ami_id(self, input: Option<String>) -> Self
A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.
If you specify a custom AMI, you must set Os
to Custom
.
Sourcepub fn get_ami_id(&self) -> &Option<String>
pub fn get_ami_id(&self) -> &Option<String>
A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.
If you specify a custom AMI, you must set Os
to Custom
.
Sourcepub fn ssh_key_name(self, input: impl Into<String>) -> Self
pub fn ssh_key_name(self, input: impl Into<String>) -> Self
The instance's Amazon EC2 key-pair name.
Sourcepub fn set_ssh_key_name(self, input: Option<String>) -> Self
pub fn set_ssh_key_name(self, input: Option<String>) -> Self
The instance's Amazon EC2 key-pair name.
Sourcepub fn get_ssh_key_name(&self) -> &Option<String>
pub fn get_ssh_key_name(&self) -> &Option<String>
The instance's Amazon EC2 key-pair name.
Sourcepub fn availability_zone(self, input: impl Into<String>) -> Self
pub fn availability_zone(self, input: impl Into<String>) -> Self
The instance Availability Zone. For more information, see Regions and Endpoints.
Sourcepub fn set_availability_zone(self, input: Option<String>) -> Self
pub fn set_availability_zone(self, input: Option<String>) -> Self
The instance Availability Zone. For more information, see Regions and Endpoints.
Sourcepub fn get_availability_zone(&self) -> &Option<String>
pub fn get_availability_zone(&self) -> &Option<String>
The instance Availability Zone. For more information, see Regions and Endpoints.
Sourcepub fn virtualization_type(self, input: impl Into<String>) -> Self
pub fn virtualization_type(self, input: impl Into<String>) -> Self
The instance's virtualization type, paravirtual
or hvm
.
Sourcepub fn set_virtualization_type(self, input: Option<String>) -> Self
pub fn set_virtualization_type(self, input: Option<String>) -> Self
The instance's virtualization type, paravirtual
or hvm
.
Sourcepub fn get_virtualization_type(&self) -> &Option<String>
pub fn get_virtualization_type(&self) -> &Option<String>
The instance's virtualization type, paravirtual
or hvm
.
Sourcepub fn subnet_id(self, input: impl Into<String>) -> Self
pub fn subnet_id(self, input: impl Into<String>) -> Self
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.
Sourcepub fn set_subnet_id(self, input: Option<String>) -> Self
pub fn set_subnet_id(self, input: Option<String>) -> Self
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.
Sourcepub fn get_subnet_id(&self) -> &Option<String>
pub fn get_subnet_id(&self) -> &Option<String>
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.
Sourcepub fn architecture(self, input: Architecture) -> Self
pub fn architecture(self, input: Architecture) -> Self
The instance architecture. The default option is x86_64
. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
Sourcepub fn set_architecture(self, input: Option<Architecture>) -> Self
pub fn set_architecture(self, input: Option<Architecture>) -> Self
The instance architecture. The default option is x86_64
. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
Sourcepub fn get_architecture(&self) -> &Option<Architecture>
pub fn get_architecture(&self) -> &Option<Architecture>
The instance architecture. The default option is x86_64
. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
Sourcepub fn root_device_type(self, input: RootDeviceType) -> Self
pub fn root_device_type(self, input: RootDeviceType) -> Self
The instance root device type. For more information, see Storage for the Root Device.
Sourcepub fn set_root_device_type(self, input: Option<RootDeviceType>) -> Self
pub fn set_root_device_type(self, input: Option<RootDeviceType>) -> Self
The instance root device type. For more information, see Storage for the Root Device.
Sourcepub fn get_root_device_type(&self) -> &Option<RootDeviceType>
pub fn get_root_device_type(&self) -> &Option<RootDeviceType>
The instance root device type. For more information, see Storage for the Root Device.
Sourcepub fn block_device_mappings(self, input: BlockDeviceMapping) -> Self
pub fn block_device_mappings(self, input: BlockDeviceMapping) -> Self
Appends an item to BlockDeviceMappings
.
To override the contents of this collection use set_block_device_mappings
.
An array of BlockDeviceMapping
objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.
Sourcepub fn set_block_device_mappings(
self,
input: Option<Vec<BlockDeviceMapping>>,
) -> Self
pub fn set_block_device_mappings( self, input: Option<Vec<BlockDeviceMapping>>, ) -> Self
An array of BlockDeviceMapping
objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.
Sourcepub fn get_block_device_mappings(&self) -> &Option<Vec<BlockDeviceMapping>>
pub fn get_block_device_mappings(&self) -> &Option<Vec<BlockDeviceMapping>>
An array of BlockDeviceMapping
objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.
Sourcepub fn install_updates_on_boot(self, input: bool) -> Self
pub fn install_updates_on_boot(self, input: bool) -> Self
Whether to install operating system and package updates when the instance boots. The default value is true
. To control when updates are installed, set this value to false
. You must then update your instances manually by using CreateDeployment
to run the update_dependencies
stack command or by manually running yum
(Amazon Linux) or apt-get
(Ubuntu) on the instances.
We strongly recommend using the default value of true
to ensure that your instances have the latest security updates.
Sourcepub fn set_install_updates_on_boot(self, input: Option<bool>) -> Self
pub fn set_install_updates_on_boot(self, input: Option<bool>) -> Self
Whether to install operating system and package updates when the instance boots. The default value is true
. To control when updates are installed, set this value to false
. You must then update your instances manually by using CreateDeployment
to run the update_dependencies
stack command or by manually running yum
(Amazon Linux) or apt-get
(Ubuntu) on the instances.
We strongly recommend using the default value of true
to ensure that your instances have the latest security updates.
Sourcepub fn get_install_updates_on_boot(&self) -> &Option<bool>
pub fn get_install_updates_on_boot(&self) -> &Option<bool>
Whether to install operating system and package updates when the instance boots. The default value is true
. To control when updates are installed, set this value to false
. You must then update your instances manually by using CreateDeployment
to run the update_dependencies
stack command or by manually running yum
(Amazon Linux) or apt-get
(Ubuntu) on the instances.
We strongly recommend using the default value of true
to ensure that your instances have the latest security updates.
Sourcepub fn ebs_optimized(self, input: bool) -> Self
pub fn ebs_optimized(self, input: bool) -> Self
Whether to create an Amazon EBS-optimized instance.
Sourcepub fn set_ebs_optimized(self, input: Option<bool>) -> Self
pub fn set_ebs_optimized(self, input: Option<bool>) -> Self
Whether to create an Amazon EBS-optimized instance.
Sourcepub fn get_ebs_optimized(&self) -> &Option<bool>
pub fn get_ebs_optimized(&self) -> &Option<bool>
Whether to create an Amazon EBS-optimized instance.
Sourcepub fn agent_version(self, input: impl Into<String>) -> Self
pub fn agent_version(self, input: impl Into<String>) -> Self
The default OpsWorks Stacks agent version. You have the following options:
-
INHERIT
- Use the stack's default agent version setting. -
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance.
The default setting is INHERIT
. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions
. AgentVersion cannot be set to Chef 12.2.
Sourcepub fn set_agent_version(self, input: Option<String>) -> Self
pub fn set_agent_version(self, input: Option<String>) -> Self
The default OpsWorks Stacks agent version. You have the following options:
-
INHERIT
- Use the stack's default agent version setting. -
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance.
The default setting is INHERIT
. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions
. AgentVersion cannot be set to Chef 12.2.
Sourcepub fn get_agent_version(&self) -> &Option<String>
pub fn get_agent_version(&self) -> &Option<String>
The default OpsWorks Stacks agent version. You have the following options:
-
INHERIT
- Use the stack's default agent version setting. -
version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance.
The default setting is INHERIT
. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions
. AgentVersion cannot be set to Chef 12.2.
Sourcepub fn tenancy(self, input: impl Into<String>) -> Self
pub fn tenancy(self, input: impl Into<String>) -> Self
The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated
, default
, or host
. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.
Sourcepub fn set_tenancy(self, input: Option<String>) -> Self
pub fn set_tenancy(self, input: Option<String>) -> Self
The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated
, default
, or host
. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.
Sourcepub fn get_tenancy(&self) -> &Option<String>
pub fn get_tenancy(&self) -> &Option<String>
The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated
, default
, or host
. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.
Trait Implementations§
Source§impl Clone for CreateInstanceFluentBuilder
impl Clone for CreateInstanceFluentBuilder
Source§fn clone(&self) -> CreateInstanceFluentBuilder
fn clone(&self) -> CreateInstanceFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateInstanceFluentBuilder
impl !RefUnwindSafe for CreateInstanceFluentBuilder
impl Send for CreateInstanceFluentBuilder
impl Sync for CreateInstanceFluentBuilder
impl Unpin for CreateInstanceFluentBuilder
impl !UnwindSafe for CreateInstanceFluentBuilder
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);