pub struct UpdateFirewallRuleFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateFirewallRule
.
Updates the specified firewall rule.
Implementations§
Source§impl UpdateFirewallRuleFluentBuilder
impl UpdateFirewallRuleFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateFirewallRuleInputBuilder
pub fn as_input(&self) -> &UpdateFirewallRuleInputBuilder
Access the UpdateFirewallRule as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateFirewallRuleOutput, SdkError<UpdateFirewallRuleError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateFirewallRuleOutput, SdkError<UpdateFirewallRuleError, 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<UpdateFirewallRuleOutput, UpdateFirewallRuleError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateFirewallRuleOutput, UpdateFirewallRuleError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn firewall_rule_group_id(self, input: impl Into<String>) -> Self
pub fn firewall_rule_group_id(self, input: impl Into<String>) -> Self
The unique identifier of the firewall rule group for the rule.
Sourcepub fn set_firewall_rule_group_id(self, input: Option<String>) -> Self
pub fn set_firewall_rule_group_id(self, input: Option<String>) -> Self
The unique identifier of the firewall rule group for the rule.
Sourcepub fn get_firewall_rule_group_id(&self) -> &Option<String>
pub fn get_firewall_rule_group_id(&self) -> &Option<String>
The unique identifier of the firewall rule group for the rule.
Sourcepub fn firewall_domain_list_id(self, input: impl Into<String>) -> Self
pub fn firewall_domain_list_id(self, input: impl Into<String>) -> Self
The ID of the domain list to use in the rule.
Sourcepub fn set_firewall_domain_list_id(self, input: Option<String>) -> Self
pub fn set_firewall_domain_list_id(self, input: Option<String>) -> Self
The ID of the domain list to use in the rule.
Sourcepub fn get_firewall_domain_list_id(&self) -> &Option<String>
pub fn get_firewall_domain_list_id(&self) -> &Option<String>
The ID of the domain list to use in the rule.
Sourcepub fn firewall_threat_protection_id(self, input: impl Into<String>) -> Self
pub fn firewall_threat_protection_id(self, input: impl Into<String>) -> Self
The DNS Firewall Advanced rule ID.
Sourcepub fn set_firewall_threat_protection_id(self, input: Option<String>) -> Self
pub fn set_firewall_threat_protection_id(self, input: Option<String>) -> Self
The DNS Firewall Advanced rule ID.
Sourcepub fn get_firewall_threat_protection_id(&self) -> &Option<String>
pub fn get_firewall_threat_protection_id(&self) -> &Option<String>
The DNS Firewall Advanced rule ID.
Sourcepub fn priority(self, input: i32) -> Self
pub fn priority(self, input: i32) -> Self
The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
Sourcepub fn set_priority(self, input: Option<i32>) -> Self
pub fn set_priority(self, input: Option<i32>) -> Self
The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
Sourcepub fn get_priority(&self) -> &Option<i32>
pub fn get_priority(&self) -> &Option<i32>
The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
Sourcepub fn action(self, input: Action) -> Self
pub fn action(self, input: Action) -> Self
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:
-
ALLOW
- Permit the request to go through. Not available for DNS Firewall Advanced rules. -
ALERT
- Permit the request to go through but send an alert to the logs. -
BLOCK
- Disallow the request. This option requires additional details in the rule'sBlockResponse
.
Sourcepub fn set_action(self, input: Option<Action>) -> Self
pub fn set_action(self, input: Option<Action>) -> Self
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:
-
ALLOW
- Permit the request to go through. Not available for DNS Firewall Advanced rules. -
ALERT
- Permit the request to go through but send an alert to the logs. -
BLOCK
- Disallow the request. This option requires additional details in the rule'sBlockResponse
.
Sourcepub fn get_action(&self) -> &Option<Action>
pub fn get_action(&self) -> &Option<Action>
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:
-
ALLOW
- Permit the request to go through. Not available for DNS Firewall Advanced rules. -
ALERT
- Permit the request to go through but send an alert to the logs. -
BLOCK
- Disallow the request. This option requires additional details in the rule'sBlockResponse
.
Sourcepub fn block_response(self, input: BlockResponse) -> Self
pub fn block_response(self, input: BlockResponse) -> Self
The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK
.
-
NODATA
- Respond indicating that the query was successful, but no response is available for it. -
NXDOMAIN
- Respond indicating that the domain name that's in the query doesn't exist. -
OVERRIDE
- Provide a custom override in the response. This option requires custom handling details in the rule'sBlockOverride*
settings.
Sourcepub fn set_block_response(self, input: Option<BlockResponse>) -> Self
pub fn set_block_response(self, input: Option<BlockResponse>) -> Self
The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK
.
-
NODATA
- Respond indicating that the query was successful, but no response is available for it. -
NXDOMAIN
- Respond indicating that the domain name that's in the query doesn't exist. -
OVERRIDE
- Provide a custom override in the response. This option requires custom handling details in the rule'sBlockOverride*
settings.
Sourcepub fn get_block_response(&self) -> &Option<BlockResponse>
pub fn get_block_response(&self) -> &Option<BlockResponse>
The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK
.
-
NODATA
- Respond indicating that the query was successful, but no response is available for it. -
NXDOMAIN
- Respond indicating that the domain name that's in the query doesn't exist. -
OVERRIDE
- Provide a custom override in the response. This option requires custom handling details in the rule'sBlockOverride*
settings.
Sourcepub fn block_override_domain(self, input: impl Into<String>) -> Self
pub fn block_override_domain(self, input: impl Into<String>) -> Self
The custom DNS record to send back in response to the query. Used for the rule action BLOCK
with a BlockResponse
setting of OVERRIDE
.
Sourcepub fn set_block_override_domain(self, input: Option<String>) -> Self
pub fn set_block_override_domain(self, input: Option<String>) -> Self
The custom DNS record to send back in response to the query. Used for the rule action BLOCK
with a BlockResponse
setting of OVERRIDE
.
Sourcepub fn get_block_override_domain(&self) -> &Option<String>
pub fn get_block_override_domain(&self) -> &Option<String>
The custom DNS record to send back in response to the query. Used for the rule action BLOCK
with a BlockResponse
setting of OVERRIDE
.
Sourcepub fn block_override_dns_type(self, input: BlockOverrideDnsType) -> Self
pub fn block_override_dns_type(self, input: BlockOverrideDnsType) -> Self
The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain
. Used for the rule action BLOCK
with a BlockResponse
setting of OVERRIDE
.
Sourcepub fn set_block_override_dns_type(
self,
input: Option<BlockOverrideDnsType>,
) -> Self
pub fn set_block_override_dns_type( self, input: Option<BlockOverrideDnsType>, ) -> Self
The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain
. Used for the rule action BLOCK
with a BlockResponse
setting of OVERRIDE
.
Sourcepub fn get_block_override_dns_type(&self) -> &Option<BlockOverrideDnsType>
pub fn get_block_override_dns_type(&self) -> &Option<BlockOverrideDnsType>
The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain
. Used for the rule action BLOCK
with a BlockResponse
setting of OVERRIDE
.
Sourcepub fn block_override_ttl(self, input: i32) -> Self
pub fn block_override_ttl(self, input: i32) -> Self
The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK
with a BlockResponse
setting of OVERRIDE
.
Sourcepub fn set_block_override_ttl(self, input: Option<i32>) -> Self
pub fn set_block_override_ttl(self, input: Option<i32>) -> Self
The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK
with a BlockResponse
setting of OVERRIDE
.
Sourcepub fn get_block_override_ttl(&self) -> &Option<i32>
pub fn get_block_override_ttl(&self) -> &Option<i32>
The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK
with a BlockResponse
setting of OVERRIDE
.
Sourcepub fn firewall_domain_redirection_action(
self,
input: FirewallDomainRedirectionAction,
) -> Self
pub fn firewall_domain_redirection_action( self, input: FirewallDomainRedirectionAction, ) -> Self
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
INSPECT_REDIRECTION_DOMAIN
: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.
TRUST_REDIRECTION_DOMAIN
: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.
Sourcepub fn set_firewall_domain_redirection_action(
self,
input: Option<FirewallDomainRedirectionAction>,
) -> Self
pub fn set_firewall_domain_redirection_action( self, input: Option<FirewallDomainRedirectionAction>, ) -> Self
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
INSPECT_REDIRECTION_DOMAIN
: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.
TRUST_REDIRECTION_DOMAIN
: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.
Sourcepub fn get_firewall_domain_redirection_action(
&self,
) -> &Option<FirewallDomainRedirectionAction>
pub fn get_firewall_domain_redirection_action( &self, ) -> &Option<FirewallDomainRedirectionAction>
How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
INSPECT_REDIRECTION_DOMAIN
: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.
TRUST_REDIRECTION_DOMAIN
: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.
Sourcepub fn qtype(self, input: impl Into<String>) -> Self
pub fn qtype(self, input: impl Into<String>) -> Self
The DNS query type you want the rule to evaluate. Allowed values are;
-
A: Returns an IPv4 address.
-
AAAA: Returns an Ipv6 address.
-
CAA: Restricts CAs that can create SSL/TLS certifications for the domain.
-
CNAME: Returns another domain name.
-
DS: Record that identifies the DNSSEC signing key of a delegated zone.
-
MX: Specifies mail servers.
-
NAPTR: Regular-expression-based rewriting of domain names.
-
NS: Authoritative name servers.
-
PTR: Maps an IP address to a domain name.
-
SOA: Start of authority record for the zone.
-
SPF: Lists the servers authorized to send emails from a domain.
-
SRV: Application specific values that identify servers.
-
TXT: Verifies email senders and application-specific values.
-
A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.
If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, this action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled.
Sourcepub fn set_qtype(self, input: Option<String>) -> Self
pub fn set_qtype(self, input: Option<String>) -> Self
The DNS query type you want the rule to evaluate. Allowed values are;
-
A: Returns an IPv4 address.
-
AAAA: Returns an Ipv6 address.
-
CAA: Restricts CAs that can create SSL/TLS certifications for the domain.
-
CNAME: Returns another domain name.
-
DS: Record that identifies the DNSSEC signing key of a delegated zone.
-
MX: Specifies mail servers.
-
NAPTR: Regular-expression-based rewriting of domain names.
-
NS: Authoritative name servers.
-
PTR: Maps an IP address to a domain name.
-
SOA: Start of authority record for the zone.
-
SPF: Lists the servers authorized to send emails from a domain.
-
SRV: Application specific values that identify servers.
-
TXT: Verifies email senders and application-specific values.
-
A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.
If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, this action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled.
Sourcepub fn get_qtype(&self) -> &Option<String>
pub fn get_qtype(&self) -> &Option<String>
The DNS query type you want the rule to evaluate. Allowed values are;
-
A: Returns an IPv4 address.
-
AAAA: Returns an Ipv6 address.
-
CAA: Restricts CAs that can create SSL/TLS certifications for the domain.
-
CNAME: Returns another domain name.
-
DS: Record that identifies the DNSSEC signing key of a delegated zone.
-
MX: Specifies mail servers.
-
NAPTR: Regular-expression-based rewriting of domain names.
-
NS: Authoritative name servers.
-
PTR: Maps an IP address to a domain name.
-
SOA: Start of authority record for the zone.
-
SPF: Lists the servers authorized to send emails from a domain.
-
SRV: Application specific values that identify servers.
-
TXT: Verifies email senders and application-specific values.
-
A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.
If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, this action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled.
Sourcepub fn dns_threat_protection(self, input: DnsThreatProtection) -> Self
pub fn dns_threat_protection(self, input: DnsThreatProtection) -> Self
The type of the DNS Firewall Advanced rule. Valid values are:
-
DGA
: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks. -
DNS_TUNNELING
: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.
Sourcepub fn set_dns_threat_protection(
self,
input: Option<DnsThreatProtection>,
) -> Self
pub fn set_dns_threat_protection( self, input: Option<DnsThreatProtection>, ) -> Self
The type of the DNS Firewall Advanced rule. Valid values are:
-
DGA
: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks. -
DNS_TUNNELING
: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.
Sourcepub fn get_dns_threat_protection(&self) -> &Option<DnsThreatProtection>
pub fn get_dns_threat_protection(&self) -> &Option<DnsThreatProtection>
The type of the DNS Firewall Advanced rule. Valid values are:
-
DGA
: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks. -
DNS_TUNNELING
: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.
Sourcepub fn confidence_threshold(self, input: ConfidenceThreshold) -> Self
pub fn confidence_threshold(self, input: ConfidenceThreshold) -> Self
The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:
-
LOW
: Provides the highest detection rate for threats, but also increases false positives. -
MEDIUM
: Provides a balance between detecting threats and false positives. -
HIGH
: Detects only the most well corroborated threats with a low rate of false positives.
Sourcepub fn set_confidence_threshold(
self,
input: Option<ConfidenceThreshold>,
) -> Self
pub fn set_confidence_threshold( self, input: Option<ConfidenceThreshold>, ) -> Self
The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:
-
LOW
: Provides the highest detection rate for threats, but also increases false positives. -
MEDIUM
: Provides a balance between detecting threats and false positives. -
HIGH
: Detects only the most well corroborated threats with a low rate of false positives.
Sourcepub fn get_confidence_threshold(&self) -> &Option<ConfidenceThreshold>
pub fn get_confidence_threshold(&self) -> &Option<ConfidenceThreshold>
The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:
-
LOW
: Provides the highest detection rate for threats, but also increases false positives. -
MEDIUM
: Provides a balance between detecting threats and false positives. -
HIGH
: Detects only the most well corroborated threats with a low rate of false positives.
Trait Implementations§
Source§impl Clone for UpdateFirewallRuleFluentBuilder
impl Clone for UpdateFirewallRuleFluentBuilder
Source§fn clone(&self) -> UpdateFirewallRuleFluentBuilder
fn clone(&self) -> UpdateFirewallRuleFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateFirewallRuleFluentBuilder
impl !RefUnwindSafe for UpdateFirewallRuleFluentBuilder
impl Send for UpdateFirewallRuleFluentBuilder
impl Sync for UpdateFirewallRuleFluentBuilder
impl Unpin for UpdateFirewallRuleFluentBuilder
impl !UnwindSafe for UpdateFirewallRuleFluentBuilder
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);