aws_sdk_applicationinsights::types::builders

Struct ObservationBuilder

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

A builder for Observation.

Implementations§

Source§

impl ObservationBuilder

Source

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

The ID of the observation type.

Source

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

The ID of the observation type.

Source

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

The ID of the observation type.

Source

pub fn start_time(self, input: DateTime) -> Self

The time when the observation was first detected, in epoch seconds.

Source

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The time when the observation was first detected, in epoch seconds.

Source

pub fn get_start_time(&self) -> &Option<DateTime>

The time when the observation was first detected, in epoch seconds.

Source

pub fn end_time(self, input: DateTime) -> Self

The time when the observation ended, in epoch seconds.

Source

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The time when the observation ended, in epoch seconds.

Source

pub fn get_end_time(&self) -> &Option<DateTime>

The time when the observation ended, in epoch seconds.

Source

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

The source type of the observation.

Source

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

The source type of the observation.

Source

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

The source type of the observation.

Source

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

The source resource ARN of the observation.

Source

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

The source resource ARN of the observation.

Source

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

The source resource ARN of the observation.

Source

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

The log group name.

Source

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

The log group name.

Source

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

The log group name.

Source

pub fn line_time(self, input: DateTime) -> Self

The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

Source

pub fn set_line_time(self, input: Option<DateTime>) -> Self

The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

Source

pub fn get_line_time(&self) -> &Option<DateTime>

The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

Source

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

The log text of the observation.

Source

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

The log text of the observation.

Source

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

The log text of the observation.

Source

pub fn log_filter(self, input: LogFilter) -> Self

The log filter of the observation.

Source

pub fn set_log_filter(self, input: Option<LogFilter>) -> Self

The log filter of the observation.

Source

pub fn get_log_filter(&self) -> &Option<LogFilter>

The log filter of the observation.

Source

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

The namespace of the observation metric.

Source

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

The namespace of the observation metric.

Source

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

The namespace of the observation metric.

Source

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

The name of the observation metric.

Source

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

The name of the observation metric.

Source

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

The name of the observation metric.

Source

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

The unit of the source observation metric.

Source

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

The unit of the source observation metric.

Source

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

The unit of the source observation metric.

Source

pub fn value(self, input: f64) -> Self

The value of the source observation metric.

Source

pub fn set_value(self, input: Option<f64>) -> Self

The value of the source observation metric.

Source

pub fn get_value(&self) -> &Option<f64>

The value of the source observation metric.

Source

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

The ID of the CloudWatch Event-based observation related to the detected problem.

Source

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

The ID of the CloudWatch Event-based observation related to the detected problem.

Source

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

The ID of the CloudWatch Event-based observation related to the detected problem.

Source

pub fn cloud_watch_event_source(self, input: CloudWatchEventSource) -> Self

The source of the CloudWatch Event.

Source

pub fn set_cloud_watch_event_source( self, input: Option<CloudWatchEventSource>, ) -> Self

The source of the CloudWatch Event.

Source

pub fn get_cloud_watch_event_source(&self) -> &Option<CloudWatchEventSource>

The source of the CloudWatch Event.

Source

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

The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification.

Source

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

The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification.

Source

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

The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification.

Source

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

The Amazon Resource Name (ARN) of the Health Event-based observation.

Source

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

The Amazon Resource Name (ARN) of the Health Event-based observation.

Source

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

The Amazon Resource Name (ARN) of the Health Event-based observation.

Source

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

The service to which the Health Event belongs, such as EC2.

Source

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

The service to which the Health Event belongs, such as EC2.

Source

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

The service to which the Health Event belongs, such as EC2.

Source

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

The type of the Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE.

Source

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

The type of the Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE.

Source

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

The type of the Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE.

Source

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

The category of the Health event, such as issue.

Source

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

The category of the Health event, such as issue.

Source

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

The category of the Health event, such as issue.

Source

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

The description of the Health event provided by the service, such as Amazon EC2.

Source

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

The description of the Health event provided by the service, such as Amazon EC2.

Source

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

The description of the Health event provided by the service, such as Amazon EC2.

Source

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

The deployment ID of the CodeDeploy-based observation related to the detected problem.

Source

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

The deployment ID of the CodeDeploy-based observation related to the detected problem.

Source

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

The deployment ID of the CodeDeploy-based observation related to the detected problem.

Source

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

The deployment group to which the CodeDeploy deployment belongs.

Source

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

The deployment group to which the CodeDeploy deployment belongs.

Source

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

The deployment group to which the CodeDeploy deployment belongs.

Source

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

The status of the CodeDeploy deployment, for example SUCCESS or FAILURE.

Source

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

The status of the CodeDeploy deployment, for example SUCCESS or FAILURE.

Source

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

The status of the CodeDeploy deployment, for example SUCCESS or FAILURE.

Source

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

The CodeDeploy application to which the deployment belongs.

Source

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

The CodeDeploy application to which the deployment belongs.

Source

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

The CodeDeploy application to which the deployment belongs.

Source

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

The instance group to which the CodeDeploy instance belongs.

Source

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

The instance group to which the CodeDeploy instance belongs.

Source

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

The instance group to which the CodeDeploy instance belongs.

Source

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

The state of the instance, such as STOPPING or TERMINATING.

Source

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

The state of the instance, such as STOPPING or TERMINATING.

Source

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

The state of the instance, such as STOPPING or TERMINATING.

Source

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

The category of an RDS event.

Source

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

The category of an RDS event.

Source

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

The category of an RDS event.

Source

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

The message of an RDS event.

Source

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

The message of an RDS event.

Source

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

The message of an RDS event.

Source

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

The name of the S3 CloudWatch Event-based observation.

Source

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

The name of the S3 CloudWatch Event-based observation.

Source

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

The name of the S3 CloudWatch Event-based observation.

Source

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

The Amazon Resource Name (ARN) of the step function execution-based observation.

Source

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

The Amazon Resource Name (ARN) of the step function execution-based observation.

Source

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

The Amazon Resource Name (ARN) of the step function execution-based observation.

Source

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

The Amazon Resource Name (ARN) of the step function-based observation.

Source

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

The Amazon Resource Name (ARN) of the step function-based observation.

Source

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

The Amazon Resource Name (ARN) of the step function-based observation.

Source

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

The status of the step function-related observation.

Source

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

The status of the step function-related observation.

Source

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

The status of the step function-related observation.

Source

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

The input to the step function-based observation.

Source

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

The input to the step function-based observation.

Source

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

The input to the step function-based observation.

Source

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

The type of EBS CloudWatch event, such as createVolume, deleteVolume or attachVolume.

Source

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

The type of EBS CloudWatch event, such as createVolume, deleteVolume or attachVolume.

Source

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

The type of EBS CloudWatch event, such as createVolume, deleteVolume or attachVolume.

Source

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

The result of an EBS CloudWatch event, such as failed or succeeded.

Source

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

The result of an EBS CloudWatch event, such as failed or succeeded.

Source

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

The result of an EBS CloudWatch event, such as failed or succeeded.

Source

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

The cause of an EBS CloudWatch event.

Source

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

The cause of an EBS CloudWatch event.

Source

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

The cause of an EBS CloudWatch event.

Source

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

The request ID of an EBS CloudWatch event.

Source

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

The request ID of an EBS CloudWatch event.

Source

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

The request ID of an EBS CloudWatch event.

Source

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

The X-Ray request fault percentage for this node.

Source

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

The X-Ray request fault percentage for this node.

Source

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

The X-Ray request fault percentage for this node.

Source

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

The X-Ray request throttle percentage for this node.

Source

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

The X-Ray request throttle percentage for this node.

Source

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

The X-Ray request throttle percentage for this node.

Source

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

The X-Ray request error percentage for this node.

Source

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

The X-Ray request error percentage for this node.

Source

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

The X-Ray request error percentage for this node.

Source

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

The X-Ray request count for this node.

Source

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

The X-Ray request count for this node.

Source

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

The X-Ray request count for this node.

Source

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

The X-Ray node request average latency for this node.

Source

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

The X-Ray node request average latency for this node.

Source

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

The X-Ray node request average latency for this node.

Source

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

The name of the X-Ray node.

Source

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

The name of the X-Ray node.

Source

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

The name of the X-Ray node.

Source

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

The type of the X-Ray node.

Source

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

The type of the X-Ray node.

Source

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

The type of the X-Ray node.

Source

pub fn build(self) -> Observation

Consumes the builder and constructs a Observation.

Trait Implementations§

Source§

impl Clone for ObservationBuilder

Source§

fn clone(&self) -> ObservationBuilder

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 ObservationBuilder

Source§

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

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

impl Default for ObservationBuilder

Source§

fn default() -> ObservationBuilder

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

impl PartialEq for ObservationBuilder

Source§

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

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,