aws_sdk_ec2::types::builders

Struct ClientVpnEndpointBuilder

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

A builder for ClientVpnEndpoint.

Implementations§

Source§

impl ClientVpnEndpointBuilder

Source

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

The ID of the Client VPN endpoint.

Source

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

The ID of the Client VPN endpoint.

Source

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

The ID of the Client VPN endpoint.

Source

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

A brief description of the endpoint.

Source

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

A brief description of the endpoint.

Source

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

A brief description of the endpoint.

Source

pub fn status(self, input: ClientVpnEndpointStatus) -> Self

The current state of the Client VPN endpoint.

Source

pub fn set_status(self, input: Option<ClientVpnEndpointStatus>) -> Self

The current state of the Client VPN endpoint.

Source

pub fn get_status(&self) -> &Option<ClientVpnEndpointStatus>

The current state of the Client VPN endpoint.

Source

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

The date and time the Client VPN endpoint was created.

Source

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

The date and time the Client VPN endpoint was created.

Source

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

The date and time the Client VPN endpoint was created.

Source

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

The date and time the Client VPN endpoint was deleted, if applicable.

Source

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

The date and time the Client VPN endpoint was deleted, if applicable.

Source

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

The date and time the Client VPN endpoint was deleted, if applicable.

Source

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

The DNS name to be used by clients when connecting to the Client VPN endpoint.

Source

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

The DNS name to be used by clients when connecting to the Client VPN endpoint.

Source

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

The DNS name to be used by clients when connecting to the Client VPN endpoint.

Source

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

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

Source

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

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

Source

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

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

Source

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

Appends an item to dns_servers.

To override the contents of this collection use set_dns_servers.

Information about the DNS servers to be used for DNS resolution.

Source

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

Information about the DNS servers to be used for DNS resolution.

Source

pub fn get_dns_servers(&self) -> &Option<Vec<String>>

Information about the DNS servers to be used for DNS resolution.

Source

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

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.

Source

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

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.

Source

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

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.

Source

pub fn vpn_protocol(self, input: VpnProtocol) -> Self

The protocol used by the VPN session.

Source

pub fn set_vpn_protocol(self, input: Option<VpnProtocol>) -> Self

The protocol used by the VPN session.

Source

pub fn get_vpn_protocol(&self) -> &Option<VpnProtocol>

The protocol used by the VPN session.

Source

pub fn transport_protocol(self, input: TransportProtocol) -> Self

The transport protocol used by the Client VPN endpoint.

Source

pub fn set_transport_protocol(self, input: Option<TransportProtocol>) -> Self

The transport protocol used by the Client VPN endpoint.

Source

pub fn get_transport_protocol(&self) -> &Option<TransportProtocol>

The transport protocol used by the Client VPN endpoint.

Source

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

The port number for the Client VPN endpoint.

Source

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

The port number for the Client VPN endpoint.

Source

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

The port number for the Client VPN endpoint.

Source

pub fn associated_target_networks(self, input: AssociatedTargetNetwork) -> Self

👎Deprecated: This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.

Appends an item to associated_target_networks.

To override the contents of this collection use set_associated_target_networks.

Information about the associated target networks. A target network is a subnet in a VPC.

Source

pub fn set_associated_target_networks( self, input: Option<Vec<AssociatedTargetNetwork>>, ) -> Self

👎Deprecated: This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.

Information about the associated target networks. A target network is a subnet in a VPC.

Source

pub fn get_associated_target_networks( &self, ) -> &Option<Vec<AssociatedTargetNetwork>>

👎Deprecated: This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.

Information about the associated target networks. A target network is a subnet in a VPC.

Source

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

The ARN of the server certificate.

Source

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

The ARN of the server certificate.

Source

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

The ARN of the server certificate.

Source

pub fn authentication_options(self, input: ClientVpnAuthentication) -> Self

Appends an item to authentication_options.

To override the contents of this collection use set_authentication_options.

Information about the authentication method used by the Client VPN endpoint.

Source

pub fn set_authentication_options( self, input: Option<Vec<ClientVpnAuthentication>>, ) -> Self

Information about the authentication method used by the Client VPN endpoint.

Source

pub fn get_authentication_options( &self, ) -> &Option<Vec<ClientVpnAuthentication>>

Information about the authentication method used by the Client VPN endpoint.

Source

pub fn connection_log_options(self, input: ConnectionLogResponseOptions) -> Self

Information about the client connection logging options for the Client VPN endpoint.

Source

pub fn set_connection_log_options( self, input: Option<ConnectionLogResponseOptions>, ) -> Self

Information about the client connection logging options for the Client VPN endpoint.

Source

pub fn get_connection_log_options( &self, ) -> &Option<ConnectionLogResponseOptions>

Information about the client connection logging options for the Client VPN endpoint.

Source

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

Appends an item to tags.

To override the contents of this collection use set_tags.

Any tags assigned to the Client VPN endpoint.

Source

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

Any tags assigned to the Client VPN endpoint.

Source

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

Any tags assigned to the Client VPN endpoint.

Source

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

Appends an item to security_group_ids.

To override the contents of this collection use set_security_group_ids.

The IDs of the security groups for the target network.

Source

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

The IDs of the security groups for the target network.

Source

pub fn get_security_group_ids(&self) -> &Option<Vec<String>>

The IDs of the security groups for the target network.

Source

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

The ID of the VPC.

Source

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

The ID of the VPC.

Source

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

The ID of the VPC.

Source

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

The URL of the self-service portal.

Source

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

The URL of the self-service portal.

Source

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

The URL of the self-service portal.

Source

pub fn client_connect_options(self, input: ClientConnectResponseOptions) -> Self

The options for managing connection authorization for new client connections.

Source

pub fn set_client_connect_options( self, input: Option<ClientConnectResponseOptions>, ) -> Self

The options for managing connection authorization for new client connections.

Source

pub fn get_client_connect_options( &self, ) -> &Option<ClientConnectResponseOptions>

The options for managing connection authorization for new client connections.

Source

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

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

Source

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

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

Source

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

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

Source

pub fn client_login_banner_options( self, input: ClientLoginBannerResponseOptions, ) -> Self

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

Source

pub fn set_client_login_banner_options( self, input: Option<ClientLoginBannerResponseOptions>, ) -> Self

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

Source

pub fn get_client_login_banner_options( &self, ) -> &Option<ClientLoginBannerResponseOptions>

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

Source

pub fn client_route_enforcement_options( self, input: ClientRouteEnforcementResponseOptions, ) -> Self

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.

Source

pub fn set_client_route_enforcement_options( self, input: Option<ClientRouteEnforcementResponseOptions>, ) -> Self

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.

Source

pub fn get_client_route_enforcement_options( &self, ) -> &Option<ClientRouteEnforcementResponseOptions>

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.

Source

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

Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.

Source

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

Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.

Source

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

Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.

Source

pub fn build(self) -> ClientVpnEndpoint

Consumes the builder and constructs a ClientVpnEndpoint.

Trait Implementations§

Source§

impl Clone for ClientVpnEndpointBuilder

Source§

fn clone(&self) -> ClientVpnEndpointBuilder

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 ClientVpnEndpointBuilder

Source§

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

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

impl Default for ClientVpnEndpointBuilder

Source§

fn default() -> ClientVpnEndpointBuilder

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

impl PartialEq for ClientVpnEndpointBuilder

Source§

fn eq(&self, other: &ClientVpnEndpointBuilder) -> 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 ClientVpnEndpointBuilder

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,