#[non_exhaustive]pub struct IpamPoolBuilder { /* private fields */ }
Expand description
A builder for IpamPool
.
Implementations§
Source§impl IpamPoolBuilder
impl IpamPoolBuilder
Sourcepub fn owner_id(self, input: impl Into<String>) -> Self
pub fn owner_id(self, input: impl Into<String>) -> Self
The Amazon Web Services account ID of the owner of the IPAM pool.
Sourcepub fn set_owner_id(self, input: Option<String>) -> Self
pub fn set_owner_id(self, input: Option<String>) -> Self
The Amazon Web Services account ID of the owner of the IPAM pool.
Sourcepub fn get_owner_id(&self) -> &Option<String>
pub fn get_owner_id(&self) -> &Option<String>
The Amazon Web Services account ID of the owner of the IPAM pool.
Sourcepub fn ipam_pool_id(self, input: impl Into<String>) -> Self
pub fn ipam_pool_id(self, input: impl Into<String>) -> Self
The ID of the IPAM pool.
Sourcepub fn set_ipam_pool_id(self, input: Option<String>) -> Self
pub fn set_ipam_pool_id(self, input: Option<String>) -> Self
The ID of the IPAM pool.
Sourcepub fn get_ipam_pool_id(&self) -> &Option<String>
pub fn get_ipam_pool_id(&self) -> &Option<String>
The ID of the IPAM pool.
Sourcepub fn source_ipam_pool_id(self, input: impl Into<String>) -> Self
pub fn source_ipam_pool_id(self, input: impl Into<String>) -> Self
The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
Sourcepub fn set_source_ipam_pool_id(self, input: Option<String>) -> Self
pub fn set_source_ipam_pool_id(self, input: Option<String>) -> Self
The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
Sourcepub fn get_source_ipam_pool_id(&self) -> &Option<String>
pub fn get_source_ipam_pool_id(&self) -> &Option<String>
The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
Sourcepub fn ipam_pool_arn(self, input: impl Into<String>) -> Self
pub fn ipam_pool_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IPAM pool.
Sourcepub fn set_ipam_pool_arn(self, input: Option<String>) -> Self
pub fn set_ipam_pool_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IPAM pool.
Sourcepub fn get_ipam_pool_arn(&self) -> &Option<String>
pub fn get_ipam_pool_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IPAM pool.
Sourcepub fn ipam_scope_arn(self, input: impl Into<String>) -> Self
pub fn ipam_scope_arn(self, input: impl Into<String>) -> Self
The ARN of the scope of the IPAM pool.
Sourcepub fn set_ipam_scope_arn(self, input: Option<String>) -> Self
pub fn set_ipam_scope_arn(self, input: Option<String>) -> Self
The ARN of the scope of the IPAM pool.
Sourcepub fn get_ipam_scope_arn(&self) -> &Option<String>
pub fn get_ipam_scope_arn(&self) -> &Option<String>
The ARN of the scope of the IPAM pool.
Sourcepub fn ipam_scope_type(self, input: IpamScopeType) -> Self
pub fn ipam_scope_type(self, input: IpamScopeType) -> Self
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
Sourcepub fn set_ipam_scope_type(self, input: Option<IpamScopeType>) -> Self
pub fn set_ipam_scope_type(self, input: Option<IpamScopeType>) -> Self
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
Sourcepub fn get_ipam_scope_type(&self) -> &Option<IpamScopeType>
pub fn get_ipam_scope_type(&self) -> &Option<IpamScopeType>
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
Sourcepub fn set_ipam_arn(self, input: Option<String>) -> Self
pub fn set_ipam_arn(self, input: Option<String>) -> Self
The ARN of the IPAM.
Sourcepub fn get_ipam_arn(&self) -> &Option<String>
pub fn get_ipam_arn(&self) -> &Option<String>
The ARN of the IPAM.
Sourcepub fn ipam_region(self, input: impl Into<String>) -> Self
pub fn ipam_region(self, input: impl Into<String>) -> Self
The Amazon Web Services Region of the IPAM pool.
Sourcepub fn set_ipam_region(self, input: Option<String>) -> Self
pub fn set_ipam_region(self, input: Option<String>) -> Self
The Amazon Web Services Region of the IPAM pool.
Sourcepub fn get_ipam_region(&self) -> &Option<String>
pub fn get_ipam_region(&self) -> &Option<String>
The Amazon Web Services Region of the IPAM pool.
Sourcepub fn locale(self, input: impl Into<String>) -> Self
pub fn locale(self, input: impl Into<String>) -> Self
The locale of the IPAM pool.
The locale for the pool should be one of the following:
-
An Amazon Web Services Region where you want this IPAM pool to be available for allocations.
-
The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.
If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
Sourcepub fn set_locale(self, input: Option<String>) -> Self
pub fn set_locale(self, input: Option<String>) -> Self
The locale of the IPAM pool.
The locale for the pool should be one of the following:
-
An Amazon Web Services Region where you want this IPAM pool to be available for allocations.
-
The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.
If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
Sourcepub fn get_locale(&self) -> &Option<String>
pub fn get_locale(&self) -> &Option<String>
The locale of the IPAM pool.
The locale for the pool should be one of the following:
-
An Amazon Web Services Region where you want this IPAM pool to be available for allocations.
-
The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.
If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
Sourcepub fn pool_depth(self, input: i32) -> Self
pub fn pool_depth(self, input: i32) -> Self
The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
Sourcepub fn set_pool_depth(self, input: Option<i32>) -> Self
pub fn set_pool_depth(self, input: Option<i32>) -> Self
The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
Sourcepub fn get_pool_depth(&self) -> &Option<i32>
pub fn get_pool_depth(&self) -> &Option<i32>
The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
Sourcepub fn state(self, input: IpamPoolState) -> Self
pub fn state(self, input: IpamPoolState) -> Self
The state of the IPAM pool.
Sourcepub fn set_state(self, input: Option<IpamPoolState>) -> Self
pub fn set_state(self, input: Option<IpamPoolState>) -> Self
The state of the IPAM pool.
Sourcepub fn get_state(&self) -> &Option<IpamPoolState>
pub fn get_state(&self) -> &Option<IpamPoolState>
The state of the IPAM pool.
Sourcepub fn state_message(self, input: impl Into<String>) -> Self
pub fn state_message(self, input: impl Into<String>) -> Self
The state message.
Sourcepub fn set_state_message(self, input: Option<String>) -> Self
pub fn set_state_message(self, input: Option<String>) -> Self
The state message.
Sourcepub fn get_state_message(&self) -> &Option<String>
pub fn get_state_message(&self) -> &Option<String>
The state message.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the IPAM pool.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the IPAM pool.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the IPAM pool.
Sourcepub fn auto_import(self, input: bool) -> Self
pub fn auto_import(self, input: bool) -> Self
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
Sourcepub fn set_auto_import(self, input: Option<bool>) -> Self
pub fn set_auto_import(self, input: Option<bool>) -> Self
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
Sourcepub fn get_auto_import(&self) -> &Option<bool>
pub fn get_auto_import(&self) -> &Option<bool>
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
Sourcepub fn publicly_advertisable(self, input: bool) -> Self
pub fn publicly_advertisable(self, input: bool) -> Self
Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4
.
Sourcepub fn set_publicly_advertisable(self, input: Option<bool>) -> Self
pub fn set_publicly_advertisable(self, input: Option<bool>) -> Self
Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4
.
Sourcepub fn get_publicly_advertisable(&self) -> &Option<bool>
pub fn get_publicly_advertisable(&self) -> &Option<bool>
Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4
.
Sourcepub fn address_family(self, input: AddressFamily) -> Self
pub fn address_family(self, input: AddressFamily) -> Self
The address family of the pool.
Sourcepub fn set_address_family(self, input: Option<AddressFamily>) -> Self
pub fn set_address_family(self, input: Option<AddressFamily>) -> Self
The address family of the pool.
Sourcepub fn get_address_family(&self) -> &Option<AddressFamily>
pub fn get_address_family(&self) -> &Option<AddressFamily>
The address family of the pool.
Sourcepub fn allocation_min_netmask_length(self, input: i32) -> Self
pub fn allocation_min_netmask_length(self, input: i32) -> Self
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
Sourcepub fn set_allocation_min_netmask_length(self, input: Option<i32>) -> Self
pub fn set_allocation_min_netmask_length(self, input: Option<i32>) -> Self
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
Sourcepub fn get_allocation_min_netmask_length(&self) -> &Option<i32>
pub fn get_allocation_min_netmask_length(&self) -> &Option<i32>
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
Sourcepub fn allocation_max_netmask_length(self, input: i32) -> Self
pub fn allocation_max_netmask_length(self, input: i32) -> Self
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
Sourcepub fn set_allocation_max_netmask_length(self, input: Option<i32>) -> Self
pub fn set_allocation_max_netmask_length(self, input: Option<i32>) -> Self
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
Sourcepub fn get_allocation_max_netmask_length(&self) -> &Option<i32>
pub fn get_allocation_max_netmask_length(&self) -> &Option<i32>
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
Sourcepub fn allocation_default_netmask_length(self, input: i32) -> Self
pub fn allocation_default_netmask_length(self, input: i32) -> Self
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
Sourcepub fn set_allocation_default_netmask_length(self, input: Option<i32>) -> Self
pub fn set_allocation_default_netmask_length(self, input: Option<i32>) -> Self
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
Sourcepub fn get_allocation_default_netmask_length(&self) -> &Option<i32>
pub fn get_allocation_default_netmask_length(&self) -> &Option<i32>
The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
Appends an item to allocation_resource_tags
.
To override the contents of this collection use set_allocation_resource_tags
.
Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
Sourcepub fn aws_service(self, input: IpamPoolAwsService) -> Self
pub fn aws_service(self, input: IpamPoolAwsService) -> Self
Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
Sourcepub fn set_aws_service(self, input: Option<IpamPoolAwsService>) -> Self
pub fn set_aws_service(self, input: Option<IpamPoolAwsService>) -> Self
Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
Sourcepub fn get_aws_service(&self) -> &Option<IpamPoolAwsService>
pub fn get_aws_service(&self) -> &Option<IpamPoolAwsService>
Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.
Sourcepub fn public_ip_source(self, input: IpamPoolPublicIpSource) -> Self
pub fn public_ip_source(self, input: IpamPoolPublicIpSource) -> Self
The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP
. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
Sourcepub fn set_public_ip_source(self, input: Option<IpamPoolPublicIpSource>) -> Self
pub fn set_public_ip_source(self, input: Option<IpamPoolPublicIpSource>) -> Self
The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP
. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
Sourcepub fn get_public_ip_source(&self) -> &Option<IpamPoolPublicIpSource>
pub fn get_public_ip_source(&self) -> &Option<IpamPoolPublicIpSource>
The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP
. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
Sourcepub fn source_resource(self, input: IpamPoolSourceResource) -> Self
pub fn source_resource(self, input: IpamPoolSourceResource) -> Self
The resource used to provision CIDRs to a resource planning pool.
Sourcepub fn set_source_resource(self, input: Option<IpamPoolSourceResource>) -> Self
pub fn set_source_resource(self, input: Option<IpamPoolSourceResource>) -> Self
The resource used to provision CIDRs to a resource planning pool.
Sourcepub fn get_source_resource(&self) -> &Option<IpamPoolSourceResource>
pub fn get_source_resource(&self) -> &Option<IpamPoolSourceResource>
The resource used to provision CIDRs to a resource planning pool.
Trait Implementations§
Source§impl Clone for IpamPoolBuilder
impl Clone for IpamPoolBuilder
Source§fn clone(&self) -> IpamPoolBuilder
fn clone(&self) -> IpamPoolBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for IpamPoolBuilder
impl Debug for IpamPoolBuilder
Source§impl Default for IpamPoolBuilder
impl Default for IpamPoolBuilder
Source§fn default() -> IpamPoolBuilder
fn default() -> IpamPoolBuilder
Source§impl PartialEq for IpamPoolBuilder
impl PartialEq for IpamPoolBuilder
impl StructuralPartialEq for IpamPoolBuilder
Auto Trait Implementations§
impl Freeze for IpamPoolBuilder
impl RefUnwindSafe for IpamPoolBuilder
impl Send for IpamPoolBuilder
impl Sync for IpamPoolBuilder
impl Unpin for IpamPoolBuilder
impl UnwindSafe for IpamPoolBuilder
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);