aws_sdk_ec2::types

Struct Explanation

Source 
#[non_exhaustive]
pub struct Explanation {
Show 54 fields
    pub acl: Option<AnalysisComponent>,
    pub acl_rule: Option<AnalysisAclRule>,
    pub address: Option<String>,
    pub addresses: Option<Vec<String>>,
    pub attached_to: Option<AnalysisComponent>,
    pub availability_zones: Option<Vec<String>>,
    pub availability_zone_ids: Option<Vec<String>>,
    pub cidrs: Option<Vec<String>>,
    pub component: Option<AnalysisComponent>,
    pub customer_gateway: Option<AnalysisComponent>,
    pub destination: Option<AnalysisComponent>,
    pub destination_vpc: Option<AnalysisComponent>,
    pub direction: Option<String>,
    pub explanation_code: Option<String>,
    pub ingress_route_table: Option<AnalysisComponent>,
    pub internet_gateway: Option<AnalysisComponent>,
    pub load_balancer_arn: Option<String>,
    pub classic_load_balancer_listener: Option<AnalysisLoadBalancerListener>,
    pub load_balancer_listener_port: Option<i32>,
    pub load_balancer_target: Option<AnalysisLoadBalancerTarget>,
    pub load_balancer_target_group: Option<AnalysisComponent>,
    pub load_balancer_target_groups: Option<Vec<AnalysisComponent>>,
    pub load_balancer_target_port: Option<i32>,
    pub elastic_load_balancer_listener: Option<AnalysisComponent>,
    pub missing_component: Option<String>,
    pub nat_gateway: Option<AnalysisComponent>,
    pub network_interface: Option<AnalysisComponent>,
    pub packet_field: Option<String>,
    pub vpc_peering_connection: Option<AnalysisComponent>,
    pub port: Option<i32>,
    pub port_ranges: Option<Vec<PortRange>>,
    pub prefix_list: Option<AnalysisComponent>,
    pub protocols: Option<Vec<String>>,
    pub route_table_route: Option<AnalysisRouteTableRoute>,
    pub route_table: Option<AnalysisComponent>,
    pub security_group: Option<AnalysisComponent>,
    pub security_group_rule: Option<AnalysisSecurityGroupRule>,
    pub security_groups: Option<Vec<AnalysisComponent>>,
    pub source_vpc: Option<AnalysisComponent>,
    pub state: Option<String>,
    pub subnet: Option<AnalysisComponent>,
    pub subnet_route_table: Option<AnalysisComponent>,
    pub vpc: Option<AnalysisComponent>,
    pub vpc_endpoint: Option<AnalysisComponent>,
    pub vpn_connection: Option<AnalysisComponent>,
    pub vpn_gateway: Option<AnalysisComponent>,
    pub transit_gateway: Option<AnalysisComponent>,
    pub transit_gateway_route_table: Option<AnalysisComponent>,
    pub transit_gateway_route_table_route: Option<TransitGatewayRouteTableRoute>,
    pub transit_gateway_attachment: Option<AnalysisComponent>,
    pub component_account: Option<String>,
    pub component_region: Option<String>,
    pub firewall_stateless_rule: Option<FirewallStatelessRule>,
    pub firewall_stateful_rule: Option<FirewallStatefulRule>,

}
Expand description

Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§acl: Option<AnalysisComponent>

The network ACL.

§acl_rule: Option<AnalysisAclRule>

The network ACL rule.

§address: Option<String>

The IPv4 address, in CIDR notation.

§addresses: Option<Vec<String>>

The IPv4 addresses, in CIDR notation.

§attached_to: Option<AnalysisComponent>

The resource to which the component is attached.

§availability_zones: Option<Vec<String>>

The Availability Zones.

§availability_zone_ids: Option<Vec<String>>

The IDs of the Availability Zones.

§cidrs: Option<Vec<String>>

The CIDR ranges.

§component: Option<AnalysisComponent>

The component.

§customer_gateway: Option<AnalysisComponent>

The customer gateway.

§destination: Option<AnalysisComponent>

The destination.

§destination_vpc: Option<AnalysisComponent>

The destination VPC.

§direction: Option<String>

The direction. The following are the possible values:

  • egress

  • ingress

§explanation_code: Option<String>

The explanation code.

§ingress_route_table: Option<AnalysisComponent>

The route table.

§internet_gateway: Option<AnalysisComponent>

The internet gateway.

§load_balancer_arn: Option<String>

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

§classic_load_balancer_listener: Option<AnalysisLoadBalancerListener>

The listener for a Classic Load Balancer.

§load_balancer_listener_port: Option<i32>

The listener port of the load balancer.

§load_balancer_target: Option<AnalysisLoadBalancerTarget>

The target.

§load_balancer_target_group: Option<AnalysisComponent>

The target group.

§load_balancer_target_groups: Option<Vec<AnalysisComponent>>

The target groups.

§load_balancer_target_port: Option<i32>

The target port.

§elastic_load_balancer_listener: Option<AnalysisComponent>

The load balancer listener.

§missing_component: Option<String>

The missing component.

§nat_gateway: Option<AnalysisComponent>

The NAT gateway.

§network_interface: Option<AnalysisComponent>

The network interface.

§packet_field: Option<String>

The packet field.

§vpc_peering_connection: Option<AnalysisComponent>

The VPC peering connection.

§port: Option<i32>

The port.

§port_ranges: Option<Vec<PortRange>>

The port ranges.

§prefix_list: Option<AnalysisComponent>

The prefix list.

§protocols: Option<Vec<String>>

The protocols.

§route_table_route: Option<AnalysisRouteTableRoute>

The route table route.

§route_table: Option<AnalysisComponent>

The route table.

§security_group: Option<AnalysisComponent>

The security group.

§security_group_rule: Option<AnalysisSecurityGroupRule>

The security group rule.

§security_groups: Option<Vec<AnalysisComponent>>

The security groups.

§source_vpc: Option<AnalysisComponent>

The source VPC.

§state: Option<String>

The state.

§subnet: Option<AnalysisComponent>

The subnet.

§subnet_route_table: Option<AnalysisComponent>

The route table for the subnet.

§vpc: Option<AnalysisComponent>

The component VPC.

§vpc_endpoint: Option<AnalysisComponent>

The VPC endpoint.

§vpn_connection: Option<AnalysisComponent>

The VPN connection.

§vpn_gateway: Option<AnalysisComponent>

The VPN gateway.

§transit_gateway: Option<AnalysisComponent>

The transit gateway.

§transit_gateway_route_table: Option<AnalysisComponent>

The transit gateway route table.

§transit_gateway_route_table_route: Option<TransitGatewayRouteTableRoute>

The transit gateway route table route.

§transit_gateway_attachment: Option<AnalysisComponent>

The transit gateway attachment.

§component_account: Option<String>

The Amazon Web Services account for the component.

§component_region: Option<String>

The Region for the component.

§firewall_stateless_rule: Option<FirewallStatelessRule>

The Network Firewall stateless rule.

§firewall_stateful_rule: Option<FirewallStatefulRule>

The Network Firewall stateful rule.

Implementations§

Source§

impl Explanation

Source

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

The network ACL.

Source

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

The network ACL rule.

Source

pub fn address(&self) -> Option<&str>

The IPv4 address, in CIDR notation.

Source

pub fn addresses(&self) -> &[String]

The IPv4 addresses, in CIDR notation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .addresses.is_none().

Source

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

The resource to which the component is attached.

Source

pub fn availability_zones(&self) -> &[String]

The Availability Zones.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .availability_zones.is_none().

Source

pub fn availability_zone_ids(&self) -> &[String]

The IDs of the Availability Zones.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .availability_zone_ids.is_none().

Source

pub fn cidrs(&self) -> &[String]

The CIDR ranges.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cidrs.is_none().

Source

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

The component.

Source

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

The customer gateway.

Source

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

The destination.

Source

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

The destination VPC.

Source

pub fn direction(&self) -> Option<&str>

The direction. The following are the possible values:

  • egress

  • ingress

Source

pub fn explanation_code(&self) -> Option<&str>

The explanation code.

Source

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

The route table.

Source

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

The internet gateway.

Source

pub fn load_balancer_arn(&self) -> Option<&str>

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

Source

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

The listener for a Classic Load Balancer.

Source

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

The listener port of the load balancer.

Source

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

The target.

Source

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

The target group.

Source

pub fn load_balancer_target_groups(&self) -> &[AnalysisComponent]

The target groups.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .load_balancer_target_groups.is_none().

Source

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

The target port.

Source

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

The load balancer listener.

Source

pub fn missing_component(&self) -> Option<&str>

The missing component.

Source

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

The NAT gateway.

Source

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

The network interface.

Source

pub fn packet_field(&self) -> Option<&str>

The packet field.

Source

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

The VPC peering connection.

Source

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

The port.

Source

pub fn port_ranges(&self) -> &[PortRange]

The port ranges.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .port_ranges.is_none().

Source

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

The prefix list.

Source

pub fn protocols(&self) -> &[String]

The protocols.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .protocols.is_none().

Source

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

The route table route.

Source

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

The route table.

Source

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

The security group.

Source

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

The security group rule.

Source

pub fn security_groups(&self) -> &[AnalysisComponent]

The security groups.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_groups.is_none().

Source

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

The source VPC.

Source

pub fn state(&self) -> Option<&str>

The state.

Source

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

The subnet.

Source

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

The route table for the subnet.

Source

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

The component VPC.

Source

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

The VPC endpoint.

Source

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

The VPN connection.

Source

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

The VPN gateway.

Source

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

The transit gateway.

Source

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

The transit gateway route table.

Source

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

The transit gateway route table route.

Source

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

The transit gateway attachment.

Source

pub fn component_account(&self) -> Option<&str>

The Amazon Web Services account for the component.

Source

pub fn component_region(&self) -> Option<&str>

The Region for the component.

Source

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

The Network Firewall stateless rule.

Source

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

The Network Firewall stateful rule.

Source§

impl Explanation

Source

pub fn builder() -> ExplanationBuilder

Creates a new builder-style object to manufacture Explanation.

Trait Implementations§

Source§

impl Clone for Explanation

Source§

fn clone(&self) -> Explanation

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Explanation

Source§

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

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

impl PartialEq for Explanation

Source§

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

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

const 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 Explanation

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,