aws_sdk_elasticache::types::builders

Struct ReplicationGroupBuilder

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

A builder for ReplicationGroup.

Implementations§

Source§

impl ReplicationGroupBuilder

Source

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

The identifier for the replication group.

Source

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

The identifier for the replication group.

Source

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

The identifier for the replication group.

Source

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

The user supplied description of the replication group.

Source

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

The user supplied description of the replication group.

Source

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

The user supplied description of the replication group.

Source

pub fn global_replication_group_info( self, input: GlobalReplicationGroupInfo, ) -> Self

The name of the Global datastore and role of this replication group in the Global datastore.

Source

pub fn set_global_replication_group_info( self, input: Option<GlobalReplicationGroupInfo>, ) -> Self

The name of the Global datastore and role of this replication group in the Global datastore.

Source

pub fn get_global_replication_group_info( &self, ) -> &Option<GlobalReplicationGroupInfo>

The name of the Global datastore and role of this replication group in the Global datastore.

Source

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

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Source

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

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Source

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

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Source

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

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

Source

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

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

Source

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

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

Source

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

Appends an item to member_clusters.

To override the contents of this collection use set_member_clusters.

The names of all the cache clusters that are part of this replication group.

Source

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

The names of all the cache clusters that are part of this replication group.

Source

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

The names of all the cache clusters that are part of this replication group.

Source

pub fn node_groups(self, input: NodeGroup) -> Self

Appends an item to node_groups.

To override the contents of this collection use set_node_groups.

A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

Source

pub fn set_node_groups(self, input: Option<Vec<NodeGroup>>) -> Self

A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

Source

pub fn get_node_groups(&self) -> &Option<Vec<NodeGroup>>

A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

Source

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

The cluster ID that is used as the daily snapshot source for the replication group.

Source

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

The cluster ID that is used as the daily snapshot source for the replication group.

Source

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

The cluster ID that is used as the daily snapshot source for the replication group.

Source

pub fn automatic_failover(self, input: AutomaticFailoverStatus) -> Self

Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

Source

pub fn set_automatic_failover( self, input: Option<AutomaticFailoverStatus>, ) -> Self

Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

Source

pub fn get_automatic_failover(&self) -> &Option<AutomaticFailoverStatus>

Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

Source

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

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

Source

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

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

Source

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

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

Source

pub fn configuration_endpoint(self, input: Endpoint) -> Self

The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

Source

pub fn set_configuration_endpoint(self, input: Option<Endpoint>) -> Self

The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

Source

pub fn get_configuration_endpoint(&self) -> &Option<Endpoint>

The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

Source

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

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Source

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

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Source

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

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Source

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

Source

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

Source

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

Source

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

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

Source

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

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

Source

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

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

Source

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

The name of the compute and memory capacity node type for each node in the replication group.

Source

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

The name of the compute and memory capacity node type for each node in the replication group.

Source

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

The name of the compute and memory capacity node type for each node in the replication group.

Source

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

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

Default: false

Source

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

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

Default: false

Source

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

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

Default: false

Source

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

The date the auth token was last modified

Source

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

The date the auth token was last modified

Source

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

The date the auth token was last modified

Source

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

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

Source

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

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

Source

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

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

Source

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

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

Source

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

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

Source

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

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

Source

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

Appends an item to member_clusters_outpost_arns.

To override the contents of this collection use set_member_clusters_outpost_arns.

The outpost ARNs of the replication group's member clusters.

Source

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

The outpost ARNs of the replication group's member clusters.

Source

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

The outpost ARNs of the replication group's member clusters.

Source

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

The ID of the KMS key used to encrypt the disk in the cluster.

Source

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

The ID of the KMS key used to encrypt the disk in the cluster.

Source

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

The ID of the KMS key used to encrypt the disk in the cluster.

Source

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

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

Source

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

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

Source

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

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

Source

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

Appends an item to user_group_ids.

To override the contents of this collection use set_user_group_ids.

The ID of the user group associated to the replication group.

Source

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

The ID of the user group associated to the replication group.

Source

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

The ID of the user group associated to the replication group.

Source

pub fn log_delivery_configurations( self, input: LogDeliveryConfiguration, ) -> Self

Appends an item to log_delivery_configurations.

To override the contents of this collection use set_log_delivery_configurations.

Returns the destination, format and type of the logs.

Source

pub fn set_log_delivery_configurations( self, input: Option<Vec<LogDeliveryConfiguration>>, ) -> Self

Returns the destination, format and type of the logs.

Source

pub fn get_log_delivery_configurations( &self, ) -> &Option<Vec<LogDeliveryConfiguration>>

Returns the destination, format and type of the logs.

Source

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

The date and time when the cluster was created.

Source

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

The date and time when the cluster was created.

Source

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

The date and time when the cluster was created.

Source

pub fn data_tiering(self, input: DataTieringStatus) -> Self

Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

Source

pub fn set_data_tiering(self, input: Option<DataTieringStatus>) -> Self

Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

Source

pub fn get_data_tiering(&self) -> &Option<DataTieringStatus>

Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

Source

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

If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

Source

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

If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

Source

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

If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

Source

pub fn network_type(self, input: NetworkType) -> Self

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Source

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

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Source

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

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Source

pub fn ip_discovery(self, input: IpDiscovery) -> Self

The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Source

pub fn set_ip_discovery(self, input: Option<IpDiscovery>) -> Self

The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Source

pub fn get_ip_discovery(&self) -> &Option<IpDiscovery>

The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Source

pub fn transit_encryption_mode(self, input: TransitEncryptionMode) -> Self

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

Source

pub fn set_transit_encryption_mode( self, input: Option<TransitEncryptionMode>, ) -> Self

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

Source

pub fn get_transit_encryption_mode(&self) -> &Option<TransitEncryptionMode>

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

Source

pub fn cluster_mode(self, input: ClusterMode) -> Self

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

Source

pub fn set_cluster_mode(self, input: Option<ClusterMode>) -> Self

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

Source

pub fn get_cluster_mode(&self) -> &Option<ClusterMode>

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

Source

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

The engine used in a replication group. The options are redis, memcached or valkey.

Source

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

The engine used in a replication group. The options are redis, memcached or valkey.

Source

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

The engine used in a replication group. The options are redis, memcached or valkey.

Source

pub fn build(self) -> ReplicationGroup

Consumes the builder and constructs a ReplicationGroup.

Trait Implementations§

Source§

impl Clone for ReplicationGroupBuilder

Source§

fn clone(&self) -> ReplicationGroupBuilder

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 ReplicationGroupBuilder

Source§

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

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

impl Default for ReplicationGroupBuilder

Source§

fn default() -> ReplicationGroupBuilder

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

impl PartialEq for ReplicationGroupBuilder

Source§

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

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,