aws_sdk_ec2::types::builders

Struct ExplanationBuilder

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

A builder for Explanation.

Implementations§

Source§

impl ExplanationBuilder

Source

pub fn acl(self, input: AnalysisComponent) -> Self

The network ACL.

Source

pub fn set_acl(self, input: Option<AnalysisComponent>) -> Self

The network ACL.

Source

pub fn get_acl(&self) -> &Option<AnalysisComponent>

The network ACL.

Source

pub fn acl_rule(self, input: AnalysisAclRule) -> Self

The network ACL rule.

Source

pub fn set_acl_rule(self, input: Option<AnalysisAclRule>) -> Self

The network ACL rule.

Source

pub fn get_acl_rule(&self) -> &Option<AnalysisAclRule>

The network ACL rule.

Source

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

The IPv4 address, in CIDR notation.

Source

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

The IPv4 address, in CIDR notation.

Source

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

The IPv4 address, in CIDR notation.

Source

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

Appends an item to addresses.

To override the contents of this collection use set_addresses.

The IPv4 addresses, in CIDR notation.

Source

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

The IPv4 addresses, in CIDR notation.

Source

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

The IPv4 addresses, in CIDR notation.

Source

pub fn attached_to(self, input: AnalysisComponent) -> Self

The resource to which the component is attached.

Source

pub fn set_attached_to(self, input: Option<AnalysisComponent>) -> Self

The resource to which the component is attached.

Source

pub fn get_attached_to(&self) -> &Option<AnalysisComponent>

The resource to which the component is attached.

Source

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

Appends an item to availability_zones.

To override the contents of this collection use set_availability_zones.

The Availability Zones.

Source

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

The Availability Zones.

Source

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

The Availability Zones.

Source

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

Appends an item to availability_zone_ids.

To override the contents of this collection use set_availability_zone_ids.

The IDs of the Availability Zones.

Source

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

The IDs of the Availability Zones.

Source

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

The IDs of the Availability Zones.

Source

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

Appends an item to cidrs.

To override the contents of this collection use set_cidrs.

The CIDR ranges.

Source

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

The CIDR ranges.

Source

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

The CIDR ranges.

Source

pub fn component(self, input: AnalysisComponent) -> Self

The component.

Source

pub fn set_component(self, input: Option<AnalysisComponent>) -> Self

The component.

Source

pub fn get_component(&self) -> &Option<AnalysisComponent>

The component.

Source

pub fn customer_gateway(self, input: AnalysisComponent) -> Self

The customer gateway.

Source

pub fn set_customer_gateway(self, input: Option<AnalysisComponent>) -> Self

The customer gateway.

Source

pub fn get_customer_gateway(&self) -> &Option<AnalysisComponent>

The customer gateway.

Source

pub fn destination(self, input: AnalysisComponent) -> Self

The destination.

Source

pub fn set_destination(self, input: Option<AnalysisComponent>) -> Self

The destination.

Source

pub fn get_destination(&self) -> &Option<AnalysisComponent>

The destination.

Source

pub fn destination_vpc(self, input: AnalysisComponent) -> Self

The destination VPC.

Source

pub fn set_destination_vpc(self, input: Option<AnalysisComponent>) -> Self

The destination VPC.

Source

pub fn get_destination_vpc(&self) -> &Option<AnalysisComponent>

The destination VPC.

Source

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

The direction. The following are the possible values:

  • egress

  • ingress

Source

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

The direction. The following are the possible values:

  • egress

  • ingress

Source

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

The direction. The following are the possible values:

  • egress

  • ingress

Source

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

The explanation code.

Source

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

The explanation code.

Source

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

The explanation code.

Source

pub fn ingress_route_table(self, input: AnalysisComponent) -> Self

The route table.

Source

pub fn set_ingress_route_table(self, input: Option<AnalysisComponent>) -> Self

The route table.

Source

pub fn get_ingress_route_table(&self) -> &Option<AnalysisComponent>

The route table.

Source

pub fn internet_gateway(self, input: AnalysisComponent) -> Self

The internet gateway.

Source

pub fn set_internet_gateway(self, input: Option<AnalysisComponent>) -> Self

The internet gateway.

Source

pub fn get_internet_gateway(&self) -> &Option<AnalysisComponent>

The internet gateway.

Source

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

The Amazon Resource Name (ARN) of the load balancer.

Source

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

The Amazon Resource Name (ARN) of the load balancer.

Source

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

The Amazon Resource Name (ARN) of the load balancer.

Source

pub fn classic_load_balancer_listener( self, input: AnalysisLoadBalancerListener, ) -> Self

The listener for a Classic Load Balancer.

Source

pub fn set_classic_load_balancer_listener( self, input: Option<AnalysisLoadBalancerListener>, ) -> Self

The listener for a Classic Load Balancer.

Source

pub fn get_classic_load_balancer_listener( &self, ) -> &Option<AnalysisLoadBalancerListener>

The listener for a Classic Load Balancer.

Source

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

The listener port of the load balancer.

Source

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

The listener port of the load balancer.

Source

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

The listener port of the load balancer.

Source

pub fn load_balancer_target(self, input: AnalysisLoadBalancerTarget) -> Self

The target.

Source

pub fn set_load_balancer_target( self, input: Option<AnalysisLoadBalancerTarget>, ) -> Self

The target.

Source

pub fn get_load_balancer_target(&self) -> &Option<AnalysisLoadBalancerTarget>

The target.

Source

pub fn load_balancer_target_group(self, input: AnalysisComponent) -> Self

The target group.

Source

pub fn set_load_balancer_target_group( self, input: Option<AnalysisComponent>, ) -> Self

The target group.

Source

pub fn get_load_balancer_target_group(&self) -> &Option<AnalysisComponent>

The target group.

Source

pub fn load_balancer_target_groups(self, input: AnalysisComponent) -> Self

Appends an item to load_balancer_target_groups.

To override the contents of this collection use set_load_balancer_target_groups.

The target groups.

Source

pub fn set_load_balancer_target_groups( self, input: Option<Vec<AnalysisComponent>>, ) -> Self

The target groups.

Source

pub fn get_load_balancer_target_groups(&self) -> &Option<Vec<AnalysisComponent>>

The target groups.

Source

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

The target port.

Source

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

The target port.

Source

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

The target port.

Source

pub fn elastic_load_balancer_listener(self, input: AnalysisComponent) -> Self

The load balancer listener.

Source

pub fn set_elastic_load_balancer_listener( self, input: Option<AnalysisComponent>, ) -> Self

The load balancer listener.

Source

pub fn get_elastic_load_balancer_listener(&self) -> &Option<AnalysisComponent>

The load balancer listener.

Source

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

The missing component.

Source

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

The missing component.

Source

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

The missing component.

Source

pub fn nat_gateway(self, input: AnalysisComponent) -> Self

The NAT gateway.

Source

pub fn set_nat_gateway(self, input: Option<AnalysisComponent>) -> Self

The NAT gateway.

Source

pub fn get_nat_gateway(&self) -> &Option<AnalysisComponent>

The NAT gateway.

Source

pub fn network_interface(self, input: AnalysisComponent) -> Self

The network interface.

Source

pub fn set_network_interface(self, input: Option<AnalysisComponent>) -> Self

The network interface.

Source

pub fn get_network_interface(&self) -> &Option<AnalysisComponent>

The network interface.

Source

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

The packet field.

Source

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

The packet field.

Source

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

The packet field.

Source

pub fn vpc_peering_connection(self, input: AnalysisComponent) -> Self

The VPC peering connection.

Source

pub fn set_vpc_peering_connection( self, input: Option<AnalysisComponent>, ) -> Self

The VPC peering connection.

Source

pub fn get_vpc_peering_connection(&self) -> &Option<AnalysisComponent>

The VPC peering connection.

Source

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

The port.

Source

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

The port.

Source

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

The port.

Source

pub fn port_ranges(self, input: PortRange) -> Self

Appends an item to port_ranges.

To override the contents of this collection use set_port_ranges.

The port ranges.

Source

pub fn set_port_ranges(self, input: Option<Vec<PortRange>>) -> Self

The port ranges.

Source

pub fn get_port_ranges(&self) -> &Option<Vec<PortRange>>

The port ranges.

Source

pub fn prefix_list(self, input: AnalysisComponent) -> Self

The prefix list.

Source

pub fn set_prefix_list(self, input: Option<AnalysisComponent>) -> Self

The prefix list.

Source

pub fn get_prefix_list(&self) -> &Option<AnalysisComponent>

The prefix list.

Source

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

Appends an item to protocols.

To override the contents of this collection use set_protocols.

The protocols.

Source

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

The protocols.

Source

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

The protocols.

Source

pub fn route_table_route(self, input: AnalysisRouteTableRoute) -> Self

The route table route.

Source

pub fn set_route_table_route( self, input: Option<AnalysisRouteTableRoute>, ) -> Self

The route table route.

Source

pub fn get_route_table_route(&self) -> &Option<AnalysisRouteTableRoute>

The route table route.

Source

pub fn route_table(self, input: AnalysisComponent) -> Self

The route table.

Source

pub fn set_route_table(self, input: Option<AnalysisComponent>) -> Self

The route table.

Source

pub fn get_route_table(&self) -> &Option<AnalysisComponent>

The route table.

Source

pub fn security_group(self, input: AnalysisComponent) -> Self

The security group.

Source

pub fn set_security_group(self, input: Option<AnalysisComponent>) -> Self

The security group.

Source

pub fn get_security_group(&self) -> &Option<AnalysisComponent>

The security group.

Source

pub fn security_group_rule(self, input: AnalysisSecurityGroupRule) -> Self

The security group rule.

Source

pub fn set_security_group_rule( self, input: Option<AnalysisSecurityGroupRule>, ) -> Self

The security group rule.

Source

pub fn get_security_group_rule(&self) -> &Option<AnalysisSecurityGroupRule>

The security group rule.

Source

pub fn security_groups(self, input: AnalysisComponent) -> Self

Appends an item to security_groups.

To override the contents of this collection use set_security_groups.

The security groups.

Source

pub fn set_security_groups(self, input: Option<Vec<AnalysisComponent>>) -> Self

The security groups.

Source

pub fn get_security_groups(&self) -> &Option<Vec<AnalysisComponent>>

The security groups.

Source

pub fn source_vpc(self, input: AnalysisComponent) -> Self

The source VPC.

Source

pub fn set_source_vpc(self, input: Option<AnalysisComponent>) -> Self

The source VPC.

Source

pub fn get_source_vpc(&self) -> &Option<AnalysisComponent>

The source VPC.

Source

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

The state.

Source

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

The state.

Source

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

The state.

Source

pub fn subnet(self, input: AnalysisComponent) -> Self

The subnet.

Source

pub fn set_subnet(self, input: Option<AnalysisComponent>) -> Self

The subnet.

Source

pub fn get_subnet(&self) -> &Option<AnalysisComponent>

The subnet.

Source

pub fn subnet_route_table(self, input: AnalysisComponent) -> Self

The route table for the subnet.

Source

pub fn set_subnet_route_table(self, input: Option<AnalysisComponent>) -> Self

The route table for the subnet.

Source

pub fn get_subnet_route_table(&self) -> &Option<AnalysisComponent>

The route table for the subnet.

Source

pub fn vpc(self, input: AnalysisComponent) -> Self

The component VPC.

Source

pub fn set_vpc(self, input: Option<AnalysisComponent>) -> Self

The component VPC.

Source

pub fn get_vpc(&self) -> &Option<AnalysisComponent>

The component VPC.

Source

pub fn vpc_endpoint(self, input: AnalysisComponent) -> Self

The VPC endpoint.

Source

pub fn set_vpc_endpoint(self, input: Option<AnalysisComponent>) -> Self

The VPC endpoint.

Source

pub fn get_vpc_endpoint(&self) -> &Option<AnalysisComponent>

The VPC endpoint.

Source

pub fn vpn_connection(self, input: AnalysisComponent) -> Self

The VPN connection.

Source

pub fn set_vpn_connection(self, input: Option<AnalysisComponent>) -> Self

The VPN connection.

Source

pub fn get_vpn_connection(&self) -> &Option<AnalysisComponent>

The VPN connection.

Source

pub fn vpn_gateway(self, input: AnalysisComponent) -> Self

The VPN gateway.

Source

pub fn set_vpn_gateway(self, input: Option<AnalysisComponent>) -> Self

The VPN gateway.

Source

pub fn get_vpn_gateway(&self) -> &Option<AnalysisComponent>

The VPN gateway.

Source

pub fn transit_gateway(self, input: AnalysisComponent) -> Self

The transit gateway.

Source

pub fn set_transit_gateway(self, input: Option<AnalysisComponent>) -> Self

The transit gateway.

Source

pub fn get_transit_gateway(&self) -> &Option<AnalysisComponent>

The transit gateway.

Source

pub fn transit_gateway_route_table(self, input: AnalysisComponent) -> Self

The transit gateway route table.

Source

pub fn set_transit_gateway_route_table( self, input: Option<AnalysisComponent>, ) -> Self

The transit gateway route table.

Source

pub fn get_transit_gateway_route_table(&self) -> &Option<AnalysisComponent>

The transit gateway route table.

Source

pub fn transit_gateway_route_table_route( self, input: TransitGatewayRouteTableRoute, ) -> Self

The transit gateway route table route.

Source

pub fn set_transit_gateway_route_table_route( self, input: Option<TransitGatewayRouteTableRoute>, ) -> Self

The transit gateway route table route.

Source

pub fn get_transit_gateway_route_table_route( &self, ) -> &Option<TransitGatewayRouteTableRoute>

The transit gateway route table route.

Source

pub fn transit_gateway_attachment(self, input: AnalysisComponent) -> Self

The transit gateway attachment.

Source

pub fn set_transit_gateway_attachment( self, input: Option<AnalysisComponent>, ) -> Self

The transit gateway attachment.

Source

pub fn get_transit_gateway_attachment(&self) -> &Option<AnalysisComponent>

The transit gateway attachment.

Source

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

The Amazon Web Services account for the component.

Source

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

The Amazon Web Services account for the component.

Source

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

The Amazon Web Services account for the component.

Source

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

The Region for the component.

Source

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

The Region for the component.

Source

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

The Region for the component.

Source

pub fn firewall_stateless_rule(self, input: FirewallStatelessRule) -> Self

The Network Firewall stateless rule.

Source

pub fn set_firewall_stateless_rule( self, input: Option<FirewallStatelessRule>, ) -> Self

The Network Firewall stateless rule.

Source

pub fn get_firewall_stateless_rule(&self) -> &Option<FirewallStatelessRule>

The Network Firewall stateless rule.

Source

pub fn firewall_stateful_rule(self, input: FirewallStatefulRule) -> Self

The Network Firewall stateful rule.

Source

pub fn set_firewall_stateful_rule( self, input: Option<FirewallStatefulRule>, ) -> Self

The Network Firewall stateful rule.

Source

pub fn get_firewall_stateful_rule(&self) -> &Option<FirewallStatefulRule>

The Network Firewall stateful rule.

Source

pub fn build(self) -> Explanation

Consumes the builder and constructs a Explanation.

Trait Implementations§

Source§

impl Clone for ExplanationBuilder

Source§

fn clone(&self) -> ExplanationBuilder

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 ExplanationBuilder

Source§

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

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

impl Default for ExplanationBuilder

Source§

fn default() -> ExplanationBuilder

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

impl PartialEq for ExplanationBuilder

Source§

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

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,