#[non_exhaustive]pub struct CreatePrivateVirtualInterfaceOutputBuilder { /* private fields */ }
Expand description
A builder for CreatePrivateVirtualInterfaceOutput
.
Implementations§
Source§impl CreatePrivateVirtualInterfaceOutputBuilder
impl CreatePrivateVirtualInterfaceOutputBuilder
Sourcepub fn owner_account(self, input: impl Into<String>) -> Self
pub fn owner_account(self, input: impl Into<String>) -> Self
The ID of the Amazon Web Services account that owns the virtual interface.
Sourcepub fn set_owner_account(self, input: Option<String>) -> Self
pub fn set_owner_account(self, input: Option<String>) -> Self
The ID of the Amazon Web Services account that owns the virtual interface.
Sourcepub fn get_owner_account(&self) -> &Option<String>
pub fn get_owner_account(&self) -> &Option<String>
The ID of the Amazon Web Services account that owns the virtual interface.
Sourcepub fn virtual_interface_id(self, input: impl Into<String>) -> Self
pub fn virtual_interface_id(self, input: impl Into<String>) -> Self
The ID of the virtual interface.
Sourcepub fn set_virtual_interface_id(self, input: Option<String>) -> Self
pub fn set_virtual_interface_id(self, input: Option<String>) -> Self
The ID of the virtual interface.
Sourcepub fn get_virtual_interface_id(&self) -> &Option<String>
pub fn get_virtual_interface_id(&self) -> &Option<String>
The ID of the virtual interface.
Sourcepub fn set_location(self, input: Option<String>) -> Self
pub fn set_location(self, input: Option<String>) -> Self
The location of the connection.
Sourcepub fn get_location(&self) -> &Option<String>
pub fn get_location(&self) -> &Option<String>
The location of the connection.
Sourcepub fn connection_id(self, input: impl Into<String>) -> Self
pub fn connection_id(self, input: impl Into<String>) -> Self
The ID of the connection.
Sourcepub fn set_connection_id(self, input: Option<String>) -> Self
pub fn set_connection_id(self, input: Option<String>) -> Self
The ID of the connection.
Sourcepub fn get_connection_id(&self) -> &Option<String>
pub fn get_connection_id(&self) -> &Option<String>
The ID of the connection.
Sourcepub fn virtual_interface_type(self, input: impl Into<String>) -> Self
pub fn virtual_interface_type(self, input: impl Into<String>) -> Self
The type of virtual interface. The possible values are private
, public
and transit
.
Sourcepub fn set_virtual_interface_type(self, input: Option<String>) -> Self
pub fn set_virtual_interface_type(self, input: Option<String>) -> Self
The type of virtual interface. The possible values are private
, public
and transit
.
Sourcepub fn get_virtual_interface_type(&self) -> &Option<String>
pub fn get_virtual_interface_type(&self) -> &Option<String>
The type of virtual interface. The possible values are private
, public
and transit
.
Sourcepub fn virtual_interface_name(self, input: impl Into<String>) -> Self
pub fn virtual_interface_name(self, input: impl Into<String>) -> Self
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
Sourcepub fn set_virtual_interface_name(self, input: Option<String>) -> Self
pub fn set_virtual_interface_name(self, input: Option<String>) -> Self
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
Sourcepub fn get_virtual_interface_name(&self) -> &Option<String>
pub fn get_virtual_interface_name(&self) -> &Option<String>
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
Sourcepub fn asn(self, input: i32) -> Self
pub fn asn(self, input: i32) -> Self
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
Sourcepub fn set_asn(self, input: Option<i32>) -> Self
pub fn set_asn(self, input: Option<i32>) -> Self
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
Sourcepub fn get_asn(&self) -> &Option<i32>
pub fn get_asn(&self) -> &Option<i32>
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
Sourcepub fn amazon_side_asn(self, input: i64) -> Self
pub fn amazon_side_asn(self, input: i64) -> Self
The autonomous system number (ASN) for the Amazon side of the connection.
Sourcepub fn set_amazon_side_asn(self, input: Option<i64>) -> Self
pub fn set_amazon_side_asn(self, input: Option<i64>) -> Self
The autonomous system number (ASN) for the Amazon side of the connection.
Sourcepub fn get_amazon_side_asn(&self) -> &Option<i64>
pub fn get_amazon_side_asn(&self) -> &Option<i64>
The autonomous system number (ASN) for the Amazon side of the connection.
Sourcepub fn auth_key(self, input: impl Into<String>) -> Self
pub fn auth_key(self, input: impl Into<String>) -> Self
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Sourcepub fn set_auth_key(self, input: Option<String>) -> Self
pub fn set_auth_key(self, input: Option<String>) -> Self
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Sourcepub fn get_auth_key(&self) -> &Option<String>
pub fn get_auth_key(&self) -> &Option<String>
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Sourcepub fn amazon_address(self, input: impl Into<String>) -> Self
pub fn amazon_address(self, input: impl Into<String>) -> Self
The IP address assigned to the Amazon interface.
Sourcepub fn set_amazon_address(self, input: Option<String>) -> Self
pub fn set_amazon_address(self, input: Option<String>) -> Self
The IP address assigned to the Amazon interface.
Sourcepub fn get_amazon_address(&self) -> &Option<String>
pub fn get_amazon_address(&self) -> &Option<String>
The IP address assigned to the Amazon interface.
Sourcepub fn customer_address(self, input: impl Into<String>) -> Self
pub fn customer_address(self, input: impl Into<String>) -> Self
The IP address assigned to the customer interface.
Sourcepub fn set_customer_address(self, input: Option<String>) -> Self
pub fn set_customer_address(self, input: Option<String>) -> Self
The IP address assigned to the customer interface.
Sourcepub fn get_customer_address(&self) -> &Option<String>
pub fn get_customer_address(&self) -> &Option<String>
The IP address assigned to the customer interface.
Sourcepub fn address_family(self, input: AddressFamily) -> Self
pub fn address_family(self, input: AddressFamily) -> Self
The address family for the BGP peer.
Sourcepub fn set_address_family(self, input: Option<AddressFamily>) -> Self
pub fn set_address_family(self, input: Option<AddressFamily>) -> Self
The address family for the BGP peer.
Sourcepub fn get_address_family(&self) -> &Option<AddressFamily>
pub fn get_address_family(&self) -> &Option<AddressFamily>
The address family for the BGP peer.
Sourcepub fn virtual_interface_state(self, input: VirtualInterfaceState) -> Self
pub fn virtual_interface_state(self, input: VirtualInterfaceState) -> Self
The state of the virtual interface. The following are the possible values:
-
confirming
: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. -
verifying
: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. -
pending
: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. -
available
: A virtual interface that is able to forward traffic. -
down
: A virtual interface that is BGP down. -
testing
: A virtual interface is in this state immediately after callingStartBgpFailoverTest
and remains in this state during the duration of the test. -
deleting
: A virtual interface is in this state immediately after callingDeleteVirtualInterface
until it can no longer forward traffic. -
deleted
: A virtual interface that cannot forward traffic. -
rejected
: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in theConfirming
state is deleted by the virtual interface owner, the virtual interface enters theRejected
state. -
unknown
: The state of the virtual interface is not available.
Sourcepub fn set_virtual_interface_state(
self,
input: Option<VirtualInterfaceState>,
) -> Self
pub fn set_virtual_interface_state( self, input: Option<VirtualInterfaceState>, ) -> Self
The state of the virtual interface. The following are the possible values:
-
confirming
: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. -
verifying
: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. -
pending
: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. -
available
: A virtual interface that is able to forward traffic. -
down
: A virtual interface that is BGP down. -
testing
: A virtual interface is in this state immediately after callingStartBgpFailoverTest
and remains in this state during the duration of the test. -
deleting
: A virtual interface is in this state immediately after callingDeleteVirtualInterface
until it can no longer forward traffic. -
deleted
: A virtual interface that cannot forward traffic. -
rejected
: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in theConfirming
state is deleted by the virtual interface owner, the virtual interface enters theRejected
state. -
unknown
: The state of the virtual interface is not available.
Sourcepub fn get_virtual_interface_state(&self) -> &Option<VirtualInterfaceState>
pub fn get_virtual_interface_state(&self) -> &Option<VirtualInterfaceState>
The state of the virtual interface. The following are the possible values:
-
confirming
: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner. -
verifying
: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created. -
pending
: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic. -
available
: A virtual interface that is able to forward traffic. -
down
: A virtual interface that is BGP down. -
testing
: A virtual interface is in this state immediately after callingStartBgpFailoverTest
and remains in this state during the duration of the test. -
deleting
: A virtual interface is in this state immediately after callingDeleteVirtualInterface
until it can no longer forward traffic. -
deleted
: A virtual interface that cannot forward traffic. -
rejected
: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in theConfirming
state is deleted by the virtual interface owner, the virtual interface enters theRejected
state. -
unknown
: The state of the virtual interface is not available.
Sourcepub fn customer_router_config(self, input: impl Into<String>) -> Self
pub fn customer_router_config(self, input: impl Into<String>) -> Self
The customer router configuration.
Sourcepub fn set_customer_router_config(self, input: Option<String>) -> Self
pub fn set_customer_router_config(self, input: Option<String>) -> Self
The customer router configuration.
Sourcepub fn get_customer_router_config(&self) -> &Option<String>
pub fn get_customer_router_config(&self) -> &Option<String>
The customer router configuration.
Sourcepub fn mtu(self, input: i32) -> Self
pub fn mtu(self, input: i32) -> Self
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
Sourcepub fn set_mtu(self, input: Option<i32>) -> Self
pub fn set_mtu(self, input: Option<i32>) -> Self
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
Sourcepub fn get_mtu(&self) -> &Option<i32>
pub fn get_mtu(&self) -> &Option<i32>
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
Sourcepub fn jumbo_frame_capable(self, input: bool) -> Self
pub fn jumbo_frame_capable(self, input: bool) -> Self
Indicates whether jumbo frames are supported.
Sourcepub fn set_jumbo_frame_capable(self, input: Option<bool>) -> Self
pub fn set_jumbo_frame_capable(self, input: Option<bool>) -> Self
Indicates whether jumbo frames are supported.
Sourcepub fn get_jumbo_frame_capable(&self) -> &Option<bool>
pub fn get_jumbo_frame_capable(&self) -> &Option<bool>
Indicates whether jumbo frames are supported.
Sourcepub fn virtual_gateway_id(self, input: impl Into<String>) -> Self
pub fn virtual_gateway_id(self, input: impl Into<String>) -> Self
The ID of the virtual private gateway. Applies only to private virtual interfaces.
Sourcepub fn set_virtual_gateway_id(self, input: Option<String>) -> Self
pub fn set_virtual_gateway_id(self, input: Option<String>) -> Self
The ID of the virtual private gateway. Applies only to private virtual interfaces.
Sourcepub fn get_virtual_gateway_id(&self) -> &Option<String>
pub fn get_virtual_gateway_id(&self) -> &Option<String>
The ID of the virtual private gateway. Applies only to private virtual interfaces.
Sourcepub fn direct_connect_gateway_id(self, input: impl Into<String>) -> Self
pub fn direct_connect_gateway_id(self, input: impl Into<String>) -> Self
The ID of the Direct Connect gateway.
Sourcepub fn set_direct_connect_gateway_id(self, input: Option<String>) -> Self
pub fn set_direct_connect_gateway_id(self, input: Option<String>) -> Self
The ID of the Direct Connect gateway.
Sourcepub fn get_direct_connect_gateway_id(&self) -> &Option<String>
pub fn get_direct_connect_gateway_id(&self) -> &Option<String>
The ID of the Direct Connect gateway.
Sourcepub fn route_filter_prefixes(self, input: RouteFilterPrefix) -> Self
pub fn route_filter_prefixes(self, input: RouteFilterPrefix) -> Self
Appends an item to route_filter_prefixes
.
To override the contents of this collection use set_route_filter_prefixes
.
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
Sourcepub fn set_route_filter_prefixes(
self,
input: Option<Vec<RouteFilterPrefix>>,
) -> Self
pub fn set_route_filter_prefixes( self, input: Option<Vec<RouteFilterPrefix>>, ) -> Self
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
Sourcepub fn get_route_filter_prefixes(&self) -> &Option<Vec<RouteFilterPrefix>>
pub fn get_route_filter_prefixes(&self) -> &Option<Vec<RouteFilterPrefix>>
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
Sourcepub fn bgp_peers(self, input: BgpPeer) -> Self
pub fn bgp_peers(self, input: BgpPeer) -> Self
Appends an item to bgp_peers
.
To override the contents of this collection use set_bgp_peers
.
The BGP peers configured on this virtual interface.
Sourcepub fn set_bgp_peers(self, input: Option<Vec<BgpPeer>>) -> Self
pub fn set_bgp_peers(self, input: Option<Vec<BgpPeer>>) -> Self
The BGP peers configured on this virtual interface.
Sourcepub fn get_bgp_peers(&self) -> &Option<Vec<BgpPeer>>
pub fn get_bgp_peers(&self) -> &Option<Vec<BgpPeer>>
The BGP peers configured on this virtual interface.
Sourcepub fn region(self, input: impl Into<String>) -> Self
pub fn region(self, input: impl Into<String>) -> Self
The Amazon Web Services Region where the virtual interface is located.
Sourcepub fn set_region(self, input: Option<String>) -> Self
pub fn set_region(self, input: Option<String>) -> Self
The Amazon Web Services Region where the virtual interface is located.
Sourcepub fn get_region(&self) -> &Option<String>
pub fn get_region(&self) -> &Option<String>
The Amazon Web Services Region where the virtual interface is located.
Sourcepub fn aws_device_v2(self, input: impl Into<String>) -> Self
pub fn aws_device_v2(self, input: impl Into<String>) -> Self
The Direct Connect endpoint that terminates the physical connection.
Sourcepub fn set_aws_device_v2(self, input: Option<String>) -> Self
pub fn set_aws_device_v2(self, input: Option<String>) -> Self
The Direct Connect endpoint that terminates the physical connection.
Sourcepub fn get_aws_device_v2(&self) -> &Option<String>
pub fn get_aws_device_v2(&self) -> &Option<String>
The Direct Connect endpoint that terminates the physical connection.
Sourcepub fn aws_logical_device_id(self, input: impl Into<String>) -> Self
pub fn aws_logical_device_id(self, input: impl Into<String>) -> Self
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Sourcepub fn set_aws_logical_device_id(self, input: Option<String>) -> Self
pub fn set_aws_logical_device_id(self, input: Option<String>) -> Self
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Sourcepub fn get_aws_logical_device_id(&self) -> &Option<String>
pub fn get_aws_logical_device_id(&self) -> &Option<String>
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
The tags associated with the virtual interface.
The tags associated with the virtual interface.
The tags associated with the virtual interface.
Sourcepub fn site_link_enabled(self, input: bool) -> Self
pub fn site_link_enabled(self, input: bool) -> Self
Indicates whether SiteLink is enabled.
Sourcepub fn set_site_link_enabled(self, input: Option<bool>) -> Self
pub fn set_site_link_enabled(self, input: Option<bool>) -> Self
Indicates whether SiteLink is enabled.
Sourcepub fn get_site_link_enabled(&self) -> &Option<bool>
pub fn get_site_link_enabled(&self) -> &Option<bool>
Indicates whether SiteLink is enabled.
Sourcepub fn build(self) -> CreatePrivateVirtualInterfaceOutput
pub fn build(self) -> CreatePrivateVirtualInterfaceOutput
Consumes the builder and constructs a CreatePrivateVirtualInterfaceOutput
.
Trait Implementations§
Source§impl Clone for CreatePrivateVirtualInterfaceOutputBuilder
impl Clone for CreatePrivateVirtualInterfaceOutputBuilder
Source§fn clone(&self) -> CreatePrivateVirtualInterfaceOutputBuilder
fn clone(&self) -> CreatePrivateVirtualInterfaceOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for CreatePrivateVirtualInterfaceOutputBuilder
impl Default for CreatePrivateVirtualInterfaceOutputBuilder
Source§fn default() -> CreatePrivateVirtualInterfaceOutputBuilder
fn default() -> CreatePrivateVirtualInterfaceOutputBuilder
Source§impl PartialEq for CreatePrivateVirtualInterfaceOutputBuilder
impl PartialEq for CreatePrivateVirtualInterfaceOutputBuilder
Source§fn eq(&self, other: &CreatePrivateVirtualInterfaceOutputBuilder) -> bool
fn eq(&self, other: &CreatePrivateVirtualInterfaceOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreatePrivateVirtualInterfaceOutputBuilder
Auto Trait Implementations§
impl Freeze for CreatePrivateVirtualInterfaceOutputBuilder
impl RefUnwindSafe for CreatePrivateVirtualInterfaceOutputBuilder
impl Send for CreatePrivateVirtualInterfaceOutputBuilder
impl Sync for CreatePrivateVirtualInterfaceOutputBuilder
impl Unpin for CreatePrivateVirtualInterfaceOutputBuilder
impl UnwindSafe for CreatePrivateVirtualInterfaceOutputBuilder
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);