Struct CreatePrivateVirtualInterfaceOutputBuilder

Source
#[non_exhaustive]
pub struct CreatePrivateVirtualInterfaceOutputBuilder { /* private fields */ }
Expand description

Implementations§

Source§

impl CreatePrivateVirtualInterfaceOutputBuilder

Source

pub fn owner_account(self, input: impl Into<String>) -> Self

The ID of the Amazon Web Services account that owns the virtual interface.

Source

pub fn set_owner_account(self, input: Option<String>) -> Self

The ID of the Amazon Web Services account that owns the virtual interface.

Source

pub fn get_owner_account(&self) -> &Option<String>

The ID of the Amazon Web Services account that owns the virtual interface.

Source

pub fn virtual_interface_id(self, input: impl Into<String>) -> Self

The ID of the virtual interface.

Source

pub fn set_virtual_interface_id(self, input: Option<String>) -> Self

The ID of the virtual interface.

Source

pub fn get_virtual_interface_id(&self) -> &Option<String>

The ID of the virtual interface.

Source

pub fn location(self, input: impl Into<String>) -> Self

The location of the connection.

Source

pub fn set_location(self, input: Option<String>) -> Self

The location of the connection.

Source

pub fn get_location(&self) -> &Option<String>

The location of the connection.

Source

pub fn connection_id(self, input: impl Into<String>) -> Self

The ID of the connection.

Source

pub fn set_connection_id(self, input: Option<String>) -> Self

The ID of the connection.

Source

pub fn get_connection_id(&self) -> &Option<String>

The ID of the connection.

Source

pub fn virtual_interface_type(self, input: impl Into<String>) -> Self

The type of virtual interface. The possible values are private, public and transit.

Source

pub fn set_virtual_interface_type(self, input: Option<String>) -> Self

The type of virtual interface. The possible values are private, public and transit.

Source

pub fn get_virtual_interface_type(&self) -> &Option<String>

The type of virtual interface. The possible values are private, public and transit.

Source

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 (-).

Source

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 (-).

Source

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 (-).

Source

pub fn vlan(self, input: i32) -> Self

The ID of the VLAN.

Source

pub fn set_vlan(self, input: Option<i32>) -> Self

The ID of the VLAN.

Source

pub fn get_vlan(&self) -> &Option<i32>

The ID of the VLAN.

Source

pub fn asn(self, input: i32) -> Self

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

Source

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.

Source

pub fn get_asn(&self) -> &Option<i32>

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

Source

pub fn amazon_side_asn(self, input: i64) -> Self

The autonomous system number (ASN) for the Amazon side of the connection.

Source

pub fn set_amazon_side_asn(self, input: Option<i64>) -> Self

The autonomous system number (ASN) for the Amazon side of the connection.

Source

pub fn get_amazon_side_asn(&self) -> &Option<i64>

The autonomous system number (ASN) for the Amazon side of the connection.

Source

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.

Source

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.

Source

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.

Source

pub fn amazon_address(self, input: impl Into<String>) -> Self

The IP address assigned to the Amazon interface.

Source

pub fn set_amazon_address(self, input: Option<String>) -> Self

The IP address assigned to the Amazon interface.

Source

pub fn get_amazon_address(&self) -> &Option<String>

The IP address assigned to the Amazon interface.

Source

pub fn customer_address(self, input: impl Into<String>) -> Self

The IP address assigned to the customer interface.

Source

pub fn set_customer_address(self, input: Option<String>) -> Self

The IP address assigned to the customer interface.

Source

pub fn get_customer_address(&self) -> &Option<String>

The IP address assigned to the customer interface.

Source

pub fn address_family(self, input: AddressFamily) -> Self

The address family for the BGP peer.

Source

pub fn set_address_family(self, input: Option<AddressFamily>) -> Self

The address family for the BGP peer.

Source

pub fn get_address_family(&self) -> &Option<AddressFamily>

The address family for the BGP peer.

Source

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 calling StartBgpFailoverTest and remains in this state during the duration of the test.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface 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 the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

Source

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 calling StartBgpFailoverTest and remains in this state during the duration of the test.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface 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 the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

Source

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 calling StartBgpFailoverTest and remains in this state during the duration of the test.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface 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 the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

Source

pub fn customer_router_config(self, input: impl Into<String>) -> Self

The customer router configuration.

Source

pub fn set_customer_router_config(self, input: Option<String>) -> Self

The customer router configuration.

Source

pub fn get_customer_router_config(&self) -> &Option<String>

The customer router configuration.

Source

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

Source

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

Source

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

Source

pub fn jumbo_frame_capable(self, input: bool) -> Self

Indicates whether jumbo frames are supported.

Source

pub fn set_jumbo_frame_capable(self, input: Option<bool>) -> Self

Indicates whether jumbo frames are supported.

Source

pub fn get_jumbo_frame_capable(&self) -> &Option<bool>

Indicates whether jumbo frames are supported.

Source

pub fn virtual_gateway_id(self, input: impl Into<String>) -> Self

The ID of the virtual private gateway. Applies only to private virtual interfaces.

Source

pub fn set_virtual_gateway_id(self, input: Option<String>) -> Self

The ID of the virtual private gateway. Applies only to private virtual interfaces.

Source

pub fn get_virtual_gateway_id(&self) -> &Option<String>

The ID of the virtual private gateway. Applies only to private virtual interfaces.

Source

pub fn direct_connect_gateway_id(self, input: impl Into<String>) -> Self

The ID of the Direct Connect gateway.

Source

pub fn set_direct_connect_gateway_id(self, input: Option<String>) -> Self

The ID of the Direct Connect gateway.

Source

pub fn get_direct_connect_gateway_id(&self) -> &Option<String>

The ID of the Direct Connect gateway.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn set_bgp_peers(self, input: Option<Vec<BgpPeer>>) -> Self

The BGP peers configured on this virtual interface.

Source

pub fn get_bgp_peers(&self) -> &Option<Vec<BgpPeer>>

The BGP peers configured on this virtual interface.

Source

pub fn region(self, input: impl Into<String>) -> Self

The Amazon Web Services Region where the virtual interface is located.

Source

pub fn set_region(self, input: Option<String>) -> Self

The Amazon Web Services Region where the virtual interface is located.

Source

pub fn get_region(&self) -> &Option<String>

The Amazon Web Services Region where the virtual interface is located.

Source

pub fn aws_device_v2(self, input: impl Into<String>) -> Self

The Direct Connect endpoint that terminates the physical connection.

Source

pub fn set_aws_device_v2(self, input: Option<String>) -> Self

The Direct Connect endpoint that terminates the physical connection.

Source

pub fn get_aws_device_v2(&self) -> &Option<String>

The Direct Connect endpoint that terminates the physical connection.

Source

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.

Source

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.

Source

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.

Source

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

The tags associated with the virtual interface.

Source

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The tags associated with the virtual interface.

Source

pub fn get_tags(&self) -> &Option<Vec<Tag>>

The tags associated with the virtual interface.

Indicates whether SiteLink is enabled.

Indicates whether SiteLink is enabled.

Indicates whether SiteLink is enabled.

Source

pub fn build(self) -> CreatePrivateVirtualInterfaceOutput

Consumes the builder and constructs a CreatePrivateVirtualInterfaceOutput.

Trait Implementations§

Source§

impl Clone for CreatePrivateVirtualInterfaceOutputBuilder

Source§

fn clone(&self) -> CreatePrivateVirtualInterfaceOutputBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CreatePrivateVirtualInterfaceOutputBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CreatePrivateVirtualInterfaceOutputBuilder

Source§

fn default() -> CreatePrivateVirtualInterfaceOutputBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for CreatePrivateVirtualInterfaceOutputBuilder

Source§

fn eq(&self, other: &CreatePrivateVirtualInterfaceOutputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for CreatePrivateVirtualInterfaceOutputBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,