aws_sdk_databasemigration::types::builders

Struct ReplicationInstanceBuilder

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

A builder for ReplicationInstance.

Implementations§

Source§

impl ReplicationInstanceBuilder

Source

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

The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

Source

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

The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

Source

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

The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

Source

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

The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.

For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

Source

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

The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.

For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

Source

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

The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.

For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

Source

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

The status of the replication instance. The possible return values include:

  • "available"

  • "creating"

  • "deleted"

  • "deleting"

  • "failed"

  • "modifying"

  • "upgrading"

  • "rebooting"

  • "resetting-master-credentials"

  • "storage-full"

  • "incompatible-credentials"

  • "incompatible-network"

  • "maintenance"

Source

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

The status of the replication instance. The possible return values include:

  • "available"

  • "creating"

  • "deleted"

  • "deleting"

  • "failed"

  • "modifying"

  • "upgrading"

  • "rebooting"

  • "resetting-master-credentials"

  • "storage-full"

  • "incompatible-credentials"

  • "incompatible-network"

  • "maintenance"

Source

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

The status of the replication instance. The possible return values include:

  • "available"

  • "creating"

  • "deleted"

  • "deleting"

  • "failed"

  • "modifying"

  • "upgrading"

  • "rebooting"

  • "resetting-master-credentials"

  • "storage-full"

  • "incompatible-credentials"

  • "incompatible-network"

  • "maintenance"

Source

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

The amount of storage (in gigabytes) that is allocated for the replication instance.

Source

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

The amount of storage (in gigabytes) that is allocated for the replication instance.

Source

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

The amount of storage (in gigabytes) that is allocated for the replication instance.

Source

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

The time the replication instance was created.

Source

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

The time the replication instance was created.

Source

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

The time the replication instance was created.

Source

pub fn vpc_security_groups(self, input: VpcSecurityGroupMembership) -> Self

Appends an item to vpc_security_groups.

To override the contents of this collection use set_vpc_security_groups.

The VPC security group for the instance.

Source

pub fn set_vpc_security_groups( self, input: Option<Vec<VpcSecurityGroupMembership>>, ) -> Self

The VPC security group for the instance.

Source

pub fn get_vpc_security_groups( &self, ) -> &Option<Vec<VpcSecurityGroupMembership>>

The VPC security group for the instance.

Source

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

The Availability Zone for the instance.

Source

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

The Availability Zone for the instance.

Source

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

The Availability Zone for the instance.

Source

pub fn replication_subnet_group(self, input: ReplicationSubnetGroup) -> Self

The subnet group for the replication instance.

Source

pub fn set_replication_subnet_group( self, input: Option<ReplicationSubnetGroup>, ) -> Self

The subnet group for the replication instance.

Source

pub fn get_replication_subnet_group(&self) -> &Option<ReplicationSubnetGroup>

The subnet group for the replication instance.

Source

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

The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

Source

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

The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

Source

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

The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

Source

pub fn pending_modified_values( self, input: ReplicationPendingModifiedValues, ) -> Self

The pending modification values.

Source

pub fn set_pending_modified_values( self, input: Option<ReplicationPendingModifiedValues>, ) -> Self

The pending modification values.

Source

pub fn get_pending_modified_values( &self, ) -> &Option<ReplicationPendingModifiedValues>

The pending modification values.

Source

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

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

Source

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

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

Source

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

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

Source

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

The engine version number of the replication instance.

If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

Source

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

The engine version number of the replication instance.

If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

Source

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

The engine version number of the replication instance.

If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

Source

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

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

Source

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

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

Source

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

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

Source

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

An KMS key identifier that is used to encrypt the data on the replication instance.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Source

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

An KMS key identifier that is used to encrypt the data on the replication instance.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Source

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

An KMS key identifier that is used to encrypt the data on the replication instance.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Source

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

The Amazon Resource Name (ARN) of the replication instance.

Source

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

The Amazon Resource Name (ARN) of the replication instance.

Source

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

The Amazon Resource Name (ARN) of the replication instance.

Source

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

👎Deprecated

The public IP address of the replication instance.

Source

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

👎Deprecated

The public IP address of the replication instance.

Source

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

👎Deprecated

The public IP address of the replication instance.

Source

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

👎Deprecated

The private IP address of the replication instance.

Source

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

👎Deprecated

The private IP address of the replication instance.

Source

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

👎Deprecated

The private IP address of the replication instance.

Source

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

Appends an item to replication_instance_public_ip_addresses.

To override the contents of this collection use set_replication_instance_public_ip_addresses.

One or more public IP addresses for the replication instance.

Source

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

One or more public IP addresses for the replication instance.

Source

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

One or more public IP addresses for the replication instance.

Source

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

Appends an item to replication_instance_private_ip_addresses.

To override the contents of this collection use set_replication_instance_private_ip_addresses.

One or more private IP addresses for the replication instance.

Source

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

One or more private IP addresses for the replication instance.

Source

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

One or more private IP addresses for the replication instance.

Source

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

Appends an item to replication_instance_ipv6_addresses.

To override the contents of this collection use set_replication_instance_ipv6_addresses.

One or more IPv6 addresses for the replication instance.

Source

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

One or more IPv6 addresses for the replication instance.

Source

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

One or more IPv6 addresses for the replication instance.

Source

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

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

Source

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

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

Source

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

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

Source

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

The Availability Zone of the standby replication instance in a Multi-AZ deployment.

Source

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

The Availability Zone of the standby replication instance in a Multi-AZ deployment.

Source

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

The Availability Zone of the standby replication instance in a Multi-AZ deployment.

Source

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

The expiration date of the free replication instance that is part of the Free DMS program.

Source

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

The expiration date of the free replication instance that is part of the Free DMS program.

Source

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

The expiration date of the free replication instance that is part of the Free DMS program.

Source

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

The DNS name servers supported for the replication instance to access your on-premise source or target database.

Source

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

The DNS name servers supported for the replication instance to access your on-premise source or target database.

Source

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

The DNS name servers supported for the replication instance to access your on-premise source or target database.

Source

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

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

Source

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

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

Source

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

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

Source

pub fn kerberos_authentication_settings( self, input: KerberosAuthenticationSettings, ) -> Self

Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when replicating an instance.

Source

pub fn set_kerberos_authentication_settings( self, input: Option<KerberosAuthenticationSettings>, ) -> Self

Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when replicating an instance.

Source

pub fn get_kerberos_authentication_settings( &self, ) -> &Option<KerberosAuthenticationSettings>

Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when replicating an instance.

Source

pub fn build(self) -> ReplicationInstance

Consumes the builder and constructs a ReplicationInstance.

Trait Implementations§

Source§

impl Clone for ReplicationInstanceBuilder

Source§

fn clone(&self) -> ReplicationInstanceBuilder

Returns a copy 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 ReplicationInstanceBuilder

Source§

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

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

impl Default for ReplicationInstanceBuilder

Source§

fn default() -> ReplicationInstanceBuilder

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

impl PartialEq for ReplicationInstanceBuilder

Source§

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

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

Source§

impl<T> MaybeSendSync for T