aws_sdk_securityhub::types

Struct AwsRedshiftClusterDetails

Source 
#[non_exhaustive]
pub struct AwsRedshiftClusterDetails {
Show 44 fields
    pub allow_version_upgrade: Option<bool>,
    pub automated_snapshot_retention_period: Option<i32>,
    pub availability_zone: Option<String>,
    pub cluster_availability_status: Option<String>,
    pub cluster_create_time: Option<String>,
    pub cluster_identifier: Option<String>,
    pub cluster_nodes: Option<Vec<AwsRedshiftClusterClusterNode>>,
    pub cluster_parameter_groups: Option<Vec<AwsRedshiftClusterClusterParameterGroup>>,
    pub cluster_public_key: Option<String>,
    pub cluster_revision_number: Option<String>,
    pub cluster_security_groups: Option<Vec<AwsRedshiftClusterClusterSecurityGroup>>,
    pub cluster_snapshot_copy_status: Option<AwsRedshiftClusterClusterSnapshotCopyStatus>,
    pub cluster_status: Option<String>,
    pub cluster_subnet_group_name: Option<String>,
    pub cluster_version: Option<String>,
    pub db_name: Option<String>,
    pub deferred_maintenance_windows: Option<Vec<AwsRedshiftClusterDeferredMaintenanceWindow>>,
    pub elastic_ip_status: Option<AwsRedshiftClusterElasticIpStatus>,
    pub elastic_resize_number_of_node_options: Option<String>,
    pub encrypted: Option<bool>,
    pub endpoint: Option<AwsRedshiftClusterEndpoint>,
    pub enhanced_vpc_routing: Option<bool>,
    pub expected_next_snapshot_schedule_time: Option<String>,
    pub expected_next_snapshot_schedule_time_status: Option<String>,
    pub hsm_status: Option<AwsRedshiftClusterHsmStatus>,
    pub iam_roles: Option<Vec<AwsRedshiftClusterIamRole>>,
    pub kms_key_id: Option<String>,
    pub maintenance_track_name: Option<String>,
    pub manual_snapshot_retention_period: Option<i32>,
    pub master_username: Option<String>,
    pub next_maintenance_window_start_time: Option<String>,
    pub node_type: Option<String>,
    pub number_of_nodes: Option<i32>,
    pub pending_actions: Option<Vec<String>>,
    pub pending_modified_values: Option<AwsRedshiftClusterPendingModifiedValues>,
    pub preferred_maintenance_window: Option<String>,
    pub publicly_accessible: Option<bool>,
    pub resize_info: Option<AwsRedshiftClusterResizeInfo>,
    pub restore_status: Option<AwsRedshiftClusterRestoreStatus>,
    pub snapshot_schedule_identifier: Option<String>,
    pub snapshot_schedule_state: Option<String>,
    pub vpc_id: Option<String>,
    pub vpc_security_groups: Option<Vec<AwsRedshiftClusterVpcSecurityGroup>>,
    pub logging_status: Option<AwsRedshiftClusterLoggingStatus>,

}
Expand description

Details about an Amazon Redshift cluster.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§allow_version_upgrade: Option<bool>

Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.

§automated_snapshot_retention_period: Option<i32>

The number of days that automatic cluster snapshots are retained.

§availability_zone: Option<String>

The name of the Availability Zone in which the cluster is located.

§cluster_availability_status: Option<String>

The availability status of the cluster for queries. Possible values are the following:

  • Available - The cluster is available for queries.

  • Unavailable - The cluster is not available for queries.

  • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

  • Modifying -The cluster is intermittently available for queries due to changes that modify the cluster.

  • Failed - The cluster failed and is not available for queries.

§cluster_create_time: Option<String>

Indicates when the cluster was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

§cluster_identifier: Option<String>

The unique identifier of the cluster.

§cluster_nodes: Option<Vec<AwsRedshiftClusterClusterNode>>

The nodes in the cluster.

§cluster_parameter_groups: Option<Vec<AwsRedshiftClusterClusterParameterGroup>>

The list of cluster parameter groups that are associated with this cluster.

§cluster_public_key: Option<String>

The public key for the cluster.

§cluster_revision_number: Option<String>

The specific revision number of the database in the cluster.

§cluster_security_groups: Option<Vec<AwsRedshiftClusterClusterSecurityGroup>>

A list of cluster security groups that are associated with the cluster.

§cluster_snapshot_copy_status: Option<AwsRedshiftClusterClusterSnapshotCopyStatus>

Information about the destination Region and retention period for the cross-Region snapshot copy.

§cluster_status: Option<String>

The current status of the cluster.

Valid values: available | available, prep-for-resize | available, resize-cleanup | cancelling-resize | creating | deleting | final-snapshot | hardware-failure | incompatible-hsm | incompatible-network | incompatible-parameters | incompatible-restore | modifying | paused | rebooting | renaming | resizing | rotating-keys | storage-full | updating-hsm

§cluster_subnet_group_name: Option<String>

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

§cluster_version: Option<String>

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

§db_name: Option<String>

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

The same name is returned for the life of the cluster.

If an initial database is not specified, a database named devdev is created by default.

§deferred_maintenance_windows: Option<Vec<AwsRedshiftClusterDeferredMaintenanceWindow>>

List of time windows during which maintenance was deferred.

§elastic_ip_status: Option<AwsRedshiftClusterElasticIpStatus>

Information about the status of the Elastic IP (EIP) address.

§elastic_resize_number_of_node_options: Option<String>

The number of nodes that you can use the elastic resize method to resize the cluster to.

§encrypted: Option<bool>

Indicates whether the data in the cluster is encrypted at rest.

§endpoint: Option<AwsRedshiftClusterEndpoint>

The connection endpoint.

§enhanced_vpc_routing: Option<bool>

Indicates whether to create the cluster with enhanced VPC routing enabled.

§expected_next_snapshot_schedule_time: Option<String>

Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

§expected_next_snapshot_schedule_time_status: Option<String>

The status of the next expected snapshot.

Valid values: OnTrack | Pending

§hsm_status: Option<AwsRedshiftClusterHsmStatus>

Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.

§iam_roles: Option<Vec<AwsRedshiftClusterIamRole>>

A list of IAM roles that the cluster can use to access other Amazon Web Services services.

§kms_key_id: Option<String>

The identifier of the KMS encryption key that is used to encrypt data in the cluster.

§maintenance_track_name: Option<String>

The name of the maintenance track for the cluster.

§manual_snapshot_retention_period: Option<i32>

The default number of days to retain a manual snapshot.

If the value is -1, the snapshot is retained indefinitely.

This setting doesn't change the retention period of existing snapshots.

Valid values: Either -1 or an integer between 1 and 3,653

§master_username: Option<String>

The master user name for the cluster. This name is used to connect to the database that is specified in as the value of DBName.

§next_maintenance_window_start_time: Option<String>

Indicates the start of the next maintenance window.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

§node_type: Option<String>

The node type for the nodes in the cluster.

§number_of_nodes: Option<i32>

The number of compute nodes in the cluster.

§pending_actions: Option<Vec<String>>

A list of cluster operations that are waiting to start.

§pending_modified_values: Option<AwsRedshiftClusterPendingModifiedValues>

A list of changes to the cluster that are currently pending.

§preferred_maintenance_window: Option<String>

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

Format: :HH:MM-:HH:MM

For the day values, use mon | tue | wed | thu | fri | sat | sun

For example, sun:09:32-sun:10:02

§publicly_accessible: Option<bool>

Whether the cluster can be accessed from a public network.

§resize_info: Option<AwsRedshiftClusterResizeInfo>

Information about the resize operation for the cluster.

§restore_status: Option<AwsRedshiftClusterRestoreStatus>

Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.

§snapshot_schedule_identifier: Option<String>

A unique identifier for the cluster snapshot schedule.

§snapshot_schedule_state: Option<String>

The current state of the cluster snapshot schedule.

Valid values: MODIFYING | ACTIVE | FAILED

§vpc_id: Option<String>

The identifier of the VPC that the cluster is in, if the cluster is in a VPC.

§vpc_security_groups: Option<Vec<AwsRedshiftClusterVpcSecurityGroup>>

The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.

§logging_status: Option<AwsRedshiftClusterLoggingStatus>

Information about the logging status of the cluster.

Implementations§

Source§

impl AwsRedshiftClusterDetails

Source

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

Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.

Source

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

The number of days that automatic cluster snapshots are retained.

Source

pub fn availability_zone(&self) -> Option<&str>

The name of the Availability Zone in which the cluster is located.

Source

pub fn cluster_availability_status(&self) -> Option<&str>

The availability status of the cluster for queries. Possible values are the following:

  • Available - The cluster is available for queries.

  • Unavailable - The cluster is not available for queries.

  • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

  • Modifying -The cluster is intermittently available for queries due to changes that modify the cluster.

  • Failed - The cluster failed and is not available for queries.

Source

pub fn cluster_create_time(&self) -> Option<&str>

Indicates when the cluster was created.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

pub fn cluster_identifier(&self) -> Option<&str>

The unique identifier of the cluster.

Source

pub fn cluster_nodes(&self) -> &[AwsRedshiftClusterClusterNode]

The nodes in the cluster.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cluster_nodes.is_none().

Source

pub fn cluster_parameter_groups( &self, ) -> &[AwsRedshiftClusterClusterParameterGroup]

The list of cluster parameter groups that are associated with this cluster.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cluster_parameter_groups.is_none().

Source

pub fn cluster_public_key(&self) -> Option<&str>

The public key for the cluster.

Source

pub fn cluster_revision_number(&self) -> Option<&str>

The specific revision number of the database in the cluster.

Source

pub fn cluster_security_groups( &self, ) -> &[AwsRedshiftClusterClusterSecurityGroup]

A list of cluster security groups that are associated with the cluster.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cluster_security_groups.is_none().

Source

pub fn cluster_snapshot_copy_status( &self, ) -> Option<&AwsRedshiftClusterClusterSnapshotCopyStatus>

Information about the destination Region and retention period for the cross-Region snapshot copy.

Source

pub fn cluster_status(&self) -> Option<&str>

The current status of the cluster.

Valid values: available | available, prep-for-resize | available, resize-cleanup | cancelling-resize | creating | deleting | final-snapshot | hardware-failure | incompatible-hsm | incompatible-network | incompatible-parameters | incompatible-restore | modifying | paused | rebooting | renaming | resizing | rotating-keys | storage-full | updating-hsm

Source

pub fn cluster_subnet_group_name(&self) -> Option<&str>

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

Source

pub fn cluster_version(&self) -> Option<&str>

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

Source

pub fn db_name(&self) -> Option<&str>

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

The same name is returned for the life of the cluster.

If an initial database is not specified, a database named devdev is created by default.

Source

pub fn deferred_maintenance_windows( &self, ) -> &[AwsRedshiftClusterDeferredMaintenanceWindow]

List of time windows during which maintenance was deferred.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .deferred_maintenance_windows.is_none().

Source

pub fn elastic_ip_status(&self) -> Option<&AwsRedshiftClusterElasticIpStatus>

Information about the status of the Elastic IP (EIP) address.

Source

pub fn elastic_resize_number_of_node_options(&self) -> Option<&str>

The number of nodes that you can use the elastic resize method to resize the cluster to.

Source

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

Indicates whether the data in the cluster is encrypted at rest.

Source

pub fn endpoint(&self) -> Option<&AwsRedshiftClusterEndpoint>

The connection endpoint.

Source

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

Indicates whether to create the cluster with enhanced VPC routing enabled.

Source

pub fn expected_next_snapshot_schedule_time(&self) -> Option<&str>

Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

pub fn expected_next_snapshot_schedule_time_status(&self) -> Option<&str>

The status of the next expected snapshot.

Valid values: OnTrack | Pending

Source

pub fn hsm_status(&self) -> Option<&AwsRedshiftClusterHsmStatus>

Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.

Source

pub fn iam_roles(&self) -> &[AwsRedshiftClusterIamRole]

A list of IAM roles that the cluster can use to access other Amazon Web Services services.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .iam_roles.is_none().

Source

pub fn kms_key_id(&self) -> Option<&str>

The identifier of the KMS encryption key that is used to encrypt data in the cluster.

Source

pub fn maintenance_track_name(&self) -> Option<&str>

The name of the maintenance track for the cluster.

Source

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

The default number of days to retain a manual snapshot.

If the value is -1, the snapshot is retained indefinitely.

This setting doesn't change the retention period of existing snapshots.

Valid values: Either -1 or an integer between 1 and 3,653

Source

pub fn master_username(&self) -> Option<&str>

The master user name for the cluster. This name is used to connect to the database that is specified in as the value of DBName.

Source

pub fn next_maintenance_window_start_time(&self) -> Option<&str>

Indicates the start of the next maintenance window.

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

Source

pub fn node_type(&self) -> Option<&str>

The node type for the nodes in the cluster.

Source

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

The number of compute nodes in the cluster.

Source

pub fn pending_actions(&self) -> &[String]

A list of cluster operations that are waiting to start.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .pending_actions.is_none().

Source

pub fn pending_modified_values( &self, ) -> Option<&AwsRedshiftClusterPendingModifiedValues>

A list of changes to the cluster that are currently pending.

Source

pub fn preferred_maintenance_window(&self) -> Option<&str>

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

Format: :HH:MM-:HH:MM

For the day values, use mon | tue | wed | thu | fri | sat | sun

For example, sun:09:32-sun:10:02

Source

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

Whether the cluster can be accessed from a public network.

Source

pub fn resize_info(&self) -> Option<&AwsRedshiftClusterResizeInfo>

Information about the resize operation for the cluster.

Source

pub fn restore_status(&self) -> Option<&AwsRedshiftClusterRestoreStatus>

Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.

Source

pub fn snapshot_schedule_identifier(&self) -> Option<&str>

A unique identifier for the cluster snapshot schedule.

Source

pub fn snapshot_schedule_state(&self) -> Option<&str>

The current state of the cluster snapshot schedule.

Valid values: MODIFYING | ACTIVE | FAILED

Source

pub fn vpc_id(&self) -> Option<&str>

The identifier of the VPC that the cluster is in, if the cluster is in a VPC.

Source

pub fn vpc_security_groups(&self) -> &[AwsRedshiftClusterVpcSecurityGroup]

The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_security_groups.is_none().

Source

pub fn logging_status(&self) -> Option<&AwsRedshiftClusterLoggingStatus>

Information about the logging status of the cluster.

Source§

impl AwsRedshiftClusterDetails

Source

pub fn builder() -> AwsRedshiftClusterDetailsBuilder

Creates a new builder-style object to manufacture AwsRedshiftClusterDetails.

Trait Implementations§

Source§

impl Clone for AwsRedshiftClusterDetails

Source§

fn clone(&self) -> AwsRedshiftClusterDetails

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 AwsRedshiftClusterDetails

Source§

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

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

impl PartialEq for AwsRedshiftClusterDetails

Source§

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

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,