aws_sdk_redshift::types::builders

Struct SnapshotBuilder

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

A builder for Snapshot.

Implementations§

Source§

impl SnapshotBuilder

Source

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

The snapshot identifier that is provided in the request.

Source

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

The snapshot identifier that is provided in the request.

Source

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

The snapshot identifier that is provided in the request.

Source

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

The identifier of the cluster for which the snapshot was taken.

Source

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

The identifier of the cluster for which the snapshot was taken.

Source

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

The identifier of the cluster for which the snapshot was taken.

Source

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

The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Source

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

The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Source

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

The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Source

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

The snapshot status. The value of the status depends on the API operation used:

  • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

  • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

  • DeleteClusterSnapshot returns status as "deleted".

Source

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

The snapshot status. The value of the status depends on the API operation used:

  • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

  • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

  • DeleteClusterSnapshot returns status as "deleted".

Source

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

The snapshot status. The value of the status depends on the API operation used:

  • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

  • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

  • DeleteClusterSnapshot returns status as "deleted".

Source

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

The port that the cluster is listening on.

Source

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

The port that the cluster is listening on.

Source

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

The port that the cluster is listening on.

Source

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

The Availability Zone in which the cluster was created.

Source

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

The Availability Zone in which the cluster was created.

Source

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

The Availability Zone in which the cluster was created.

Source

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

The time (UTC) when the cluster was originally created.

Source

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

The time (UTC) when the cluster was originally created.

Source

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

The time (UTC) when the cluster was originally created.

Source

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

The admin user name for the cluster.

Source

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

The admin user name for the cluster.

Source

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

The admin user name for the cluster.

Source

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

The version ID of the Amazon Redshift engine that is running on the cluster.

Source

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

The version ID of the Amazon Redshift engine that is running on the cluster.

Source

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

The version ID of the Amazon Redshift engine that is running on the cluster.

Source

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

The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

Source

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

The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

Source

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

The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

Source

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

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

Source

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

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

Source

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

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

Source

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

The node type of the nodes in the cluster.

Source

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

The node type of the nodes in the cluster.

Source

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

The node type of the nodes in the cluster.

Source

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

The number of nodes in the cluster.

Source

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

The number of nodes in the cluster.

Source

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

The number of nodes in the cluster.

Source

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

The name of the database that was created when the cluster was created.

Source

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

The name of the database that was created when the cluster was created.

Source

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

The name of the database that was created when the cluster was created.

Source

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

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Source

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

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Source

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

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Source

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

If true, the data in the snapshot is encrypted at rest.

Source

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

If true, the data in the snapshot is encrypted at rest.

Source

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

If true, the data in the snapshot is encrypted at rest.

Source

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

The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Source

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

The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Source

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

The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Source

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

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

Source

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

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

Source

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

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

Source

pub fn accounts_with_restore_access( self, input: AccountWithRestoreAccess, ) -> Self

Appends an item to accounts_with_restore_access.

To override the contents of this collection use set_accounts_with_restore_access.

A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Source

pub fn set_accounts_with_restore_access( self, input: Option<Vec<AccountWithRestoreAccess>>, ) -> Self

A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Source

pub fn get_accounts_with_restore_access( &self, ) -> &Option<Vec<AccountWithRestoreAccess>>

A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Source

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

For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Source

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

For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Source

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

For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Source

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

The size of the complete set of backup data that would be used to restore the cluster.

Source

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

The size of the complete set of backup data that would be used to restore the cluster.

Source

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

The size of the complete set of backup data that would be used to restore the cluster.

Source

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

The size of the incremental backup.

Source

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

The size of the incremental backup.

Source

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

The size of the incremental backup.

Source

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

The number of megabytes that have been transferred to the snapshot backup.

Source

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

The number of megabytes that have been transferred to the snapshot backup.

Source

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

The number of megabytes that have been transferred to the snapshot backup.

Source

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

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Source

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

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Source

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

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Source

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

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Source

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

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Source

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

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Source

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

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Source

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

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Source

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

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Source

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

The source region from which the snapshot was copied.

Source

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

The source region from which the snapshot was copied.

Source

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

The source region from which the snapshot was copied.

Source

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

The list of tags for the cluster snapshot.

Source

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The list of tags for the cluster snapshot.

Source

pub fn get_tags(&self) -> &Option<Vec<Tag>>

The list of tags for the cluster snapshot.

Source

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

Appends an item to restorable_node_types.

To override the contents of this collection use set_restorable_node_types.

The list of node types that this cluster snapshot is able to restore into.

Source

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

The list of node types that this cluster snapshot is able to restore into.

Source

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

The list of node types that this cluster snapshot is able to restore into.

Source

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

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

Source

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

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

Source

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

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

Source

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

The name of the maintenance track for the snapshot.

Source

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

The name of the maintenance track for the snapshot.

Source

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

The name of the maintenance track for the snapshot.

Source

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

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

Source

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

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

Source

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

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

Source

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

The number of days until a manual snapshot will pass its retention period.

Source

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

The number of days until a manual snapshot will pass its retention period.

Source

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

The number of days until a manual snapshot will pass its retention period.

Source

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

A timestamp representing the start of the retention period for the snapshot.

Source

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

A timestamp representing the start of the retention period for the snapshot.

Source

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

A timestamp representing the start of the retention period for the snapshot.

Source

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

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

Source

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

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

Source

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

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

Source

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

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

Source

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

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

Source

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

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

Source

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

The Amazon Resource Name (ARN) of the snapshot.

Source

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

The Amazon Resource Name (ARN) of the snapshot.

Source

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

The Amazon Resource Name (ARN) of the snapshot.

Source

pub fn build(self) -> Snapshot

Consumes the builder and constructs a Snapshot.

Trait Implementations§

Source§

impl Clone for SnapshotBuilder

Source§

fn clone(&self) -> SnapshotBuilder

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 SnapshotBuilder

Source§

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

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

impl Default for SnapshotBuilder

Source§

fn default() -> SnapshotBuilder

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

impl PartialEq for SnapshotBuilder

Source§

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

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,