OrderableDbInstanceOptionBuilder

aws_sdk_rds::types::builders

Struct OrderableDbInstanceOptionBuilder 

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

A builder for OrderableDbInstanceOption.

Implementations§

Source§

impl OrderableDbInstanceOptionBuilder

Source

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

The engine type of a DB instance.

Source

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

The engine type of a DB instance.

Source

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

The engine type of a DB instance.

Source

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

The engine version of a DB instance.

Source

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

The engine version of a DB instance.

Source

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

The engine version of a DB instance.

Source

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

The DB instance class for a DB instance.

Source

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

The DB instance class for a DB instance.

Source

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

The DB instance class for a DB instance.

Source

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

The license model for a DB instance.

Source

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

The license model for a DB instance.

Source

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

The license model for a DB instance.

Source

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

The Availability Zone group for a DB instance.

Source

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

The Availability Zone group for a DB instance.

Source

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

The Availability Zone group for a DB instance.

Source

pub fn availability_zones(self, input: AvailabilityZone) -> Self

Appends an item to availability_zones.

To override the contents of this collection use set_availability_zones.

A list of Availability Zones for a DB instance.

Source

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

A list of Availability Zones for a DB instance.

Source

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

A list of Availability Zones for a DB instance.

Source

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

Indicates whether a DB instance is Multi-AZ capable.

Source

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

Indicates whether a DB instance is Multi-AZ capable.

Source

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

Indicates whether a DB instance is Multi-AZ capable.

Source

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

Indicates whether a DB instance can have a read replica.

Source

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

Indicates whether a DB instance can have a read replica.

Source

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

Indicates whether a DB instance can have a read replica.

Source

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

Indicates whether a DB instance is in a VPC.

Source

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

Indicates whether a DB instance is in a VPC.

Source

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

Indicates whether a DB instance is in a VPC.

Source

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

Indicates whether a DB instance supports encrypted storage.

Source

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

Indicates whether a DB instance supports encrypted storage.

Source

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

Indicates whether a DB instance supports encrypted storage.

Source

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

The storage type for a DB instance.

Source

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

The storage type for a DB instance.

Source

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

The storage type for a DB instance.

Source

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

Indicates whether a DB instance supports provisioned IOPS.

Source

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

Indicates whether a DB instance supports provisioned IOPS.

Source

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

Indicates whether a DB instance supports provisioned IOPS.

Source

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

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

Source

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

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

Source

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

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

Source

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

Indicates whether a DB instance supports IAM database authentication.

Source

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

Indicates whether a DB instance supports IAM database authentication.

Source

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

Indicates whether a DB instance supports IAM database authentication.

Source

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

Indicates whether a DB instance supports Performance Insights.

Source

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

Indicates whether a DB instance supports Performance Insights.

Source

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

Indicates whether a DB instance supports Performance Insights.

Source

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

Minimum storage size for a DB instance.

Source

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

Minimum storage size for a DB instance.

Source

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

Minimum storage size for a DB instance.

Source

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

Maximum storage size for a DB instance.

Source

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

Maximum storage size for a DB instance.

Source

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

Maximum storage size for a DB instance.

Source

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

Minimum total provisioned IOPS for a DB instance.

Source

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

Minimum total provisioned IOPS for a DB instance.

Source

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

Minimum total provisioned IOPS for a DB instance.

Source

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

Maximum total provisioned IOPS for a DB instance.

Source

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

Maximum total provisioned IOPS for a DB instance.

Source

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

Maximum total provisioned IOPS for a DB instance.

Source

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

Minimum provisioned IOPS per GiB for a DB instance.

Source

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

Minimum provisioned IOPS per GiB for a DB instance.

Source

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

Minimum provisioned IOPS per GiB for a DB instance.

Source

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

Maximum provisioned IOPS per GiB for a DB instance.

Source

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

Maximum provisioned IOPS per GiB for a DB instance.

Source

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

Maximum provisioned IOPS per GiB for a DB instance.

Source

pub fn available_processor_features( self, input: AvailableProcessorFeature, ) -> Self

Appends an item to available_processor_features.

To override the contents of this collection use set_available_processor_features.

A list of the available processor features for the DB instance class of a DB instance.

Source

pub fn set_available_processor_features( self, input: Option<Vec<AvailableProcessorFeature>>, ) -> Self

A list of the available processor features for the DB instance class of a DB instance.

Source

pub fn get_available_processor_features( &self, ) -> &Option<Vec<AvailableProcessorFeature>>

A list of the available processor features for the DB instance class of a DB instance.

Source

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

Appends an item to supported_engine_modes.

To override the contents of this collection use set_supported_engine_modes.

A list of the supported DB engine modes.

Source

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

A list of the supported DB engine modes.

Source

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

A list of the supported DB engine modes.

Source

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

Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

Source

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

Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

Source

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

Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

Source

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

Indicates whether a DB instance supports Kerberos Authentication.

Source

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

Indicates whether a DB instance supports Kerberos Authentication.

Source

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

Indicates whether a DB instance supports Kerberos Authentication.

Source

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

Indicates whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

Source

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

Indicates whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

Source

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

Indicates whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

Source

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

Appends an item to supported_activity_stream_modes.

To override the contents of this collection use set_supported_activity_stream_modes.

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value \[sync, async\]. Aurora MySQL and RDS for Oracle return \[async\] only. If Database Activity Streams isn't supported, the return value is an empty list.

Source

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

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value \[sync, async\]. Aurora MySQL and RDS for Oracle return \[async\] only. If Database Activity Streams isn't supported, the return value is an empty list.

Source

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

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value \[sync, async\]. Aurora MySQL and RDS for Oracle return \[async\] only. If Database Activity Streams isn't supported, the return value is an empty list.

Source

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

Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

Source

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

Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

Source

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

Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

Source

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

Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Source

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

Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Source

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

Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Source

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

Appends an item to supported_network_types.

To override the contents of this collection use set_supported_network_types.

The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Source

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

The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Source

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

The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Source

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

Indicates whether a DB instance supports storage throughput.

Source

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

Indicates whether a DB instance supports storage throughput.

Source

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

Indicates whether a DB instance supports storage throughput.

Source

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

Minimum storage throughput for a DB instance.

Source

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

Minimum storage throughput for a DB instance.

Source

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

Minimum storage throughput for a DB instance.

Source

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

Maximum storage throughput for a DB instance.

Source

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

Maximum storage throughput for a DB instance.

Source

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

Maximum storage throughput for a DB instance.

Source

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

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

Source

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

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

Source

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

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

Source

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

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

Source

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

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

Source

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

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

Source

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

Indicates whether a DB instance supports using a dedicated log volume (DLV).

Source

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

Indicates whether a DB instance supports using a dedicated log volume (DLV).

Source

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

Indicates whether a DB instance supports using a dedicated log volume (DLV).

Source

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

Indicates whether a DB instance supports HTTP endpoints.

Source

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

Indicates whether a DB instance supports HTTP endpoints.

Source

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

Indicates whether a DB instance supports HTTP endpoints.

Source

pub fn build(self) -> OrderableDbInstanceOption

Consumes the builder and constructs a OrderableDbInstanceOption.

Trait Implementations§

Source§

impl Clone for OrderableDbInstanceOptionBuilder

Source§

fn clone(&self) -> OrderableDbInstanceOptionBuilder

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 OrderableDbInstanceOptionBuilder

Source§

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

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

impl Default for OrderableDbInstanceOptionBuilder

Source§

fn default() -> OrderableDbInstanceOptionBuilder

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

impl PartialEq for OrderableDbInstanceOptionBuilder

Source§

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

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,