aws_sdk_securityhub::types

Struct AwsRdsDbClusterDetails

Source 
#[non_exhaustive]
pub struct AwsRdsDbClusterDetails {
Show 38 fields
    pub allocated_storage: Option<i32>,
    pub availability_zones: Option<Vec<String>>,
    pub backup_retention_period: Option<i32>,
    pub database_name: Option<String>,
    pub status: Option<String>,
    pub endpoint: Option<String>,
    pub reader_endpoint: Option<String>,
    pub custom_endpoints: Option<Vec<String>>,
    pub multi_az: Option<bool>,
    pub engine: Option<String>,
    pub engine_version: Option<String>,
    pub port: Option<i32>,
    pub master_username: Option<String>,
    pub preferred_backup_window: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub read_replica_identifiers: Option<Vec<String>>,
    pub vpc_security_groups: Option<Vec<AwsRdsDbInstanceVpcSecurityGroup>>,
    pub hosted_zone_id: Option<String>,
    pub storage_encrypted: Option<bool>,
    pub kms_key_id: Option<String>,
    pub db_cluster_resource_id: Option<String>,
    pub associated_roles: Option<Vec<AwsRdsDbClusterAssociatedRole>>,
    pub cluster_create_time: Option<String>,
    pub enabled_cloud_watch_logs_exports: Option<Vec<String>>,
    pub engine_mode: Option<String>,
    pub deletion_protection: Option<bool>,
    pub http_endpoint_enabled: Option<bool>,
    pub activity_stream_status: Option<String>,
    pub copy_tags_to_snapshot: Option<bool>,
    pub cross_account_clone: Option<bool>,
    pub domain_memberships: Option<Vec<AwsRdsDbDomainMembership>>,
    pub db_cluster_parameter_group: Option<String>,
    pub db_subnet_group: Option<String>,
    pub db_cluster_option_group_memberships: Option<Vec<AwsRdsDbClusterOptionGroupMembership>>,
    pub db_cluster_identifier: Option<String>,
    pub db_cluster_members: Option<Vec<AwsRdsDbClusterMember>>,
    pub iam_database_authentication_enabled: Option<bool>,
    pub auto_minor_version_upgrade: Option<bool>,

}
Expand description

Information about an Amazon RDS DB 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.
§allocated_storage: Option<i32>

For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

§availability_zones: Option<Vec<String>>

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

§backup_retention_period: Option<i32>

The number of days for which automated backups are retained.

§database_name: Option<String>

The name of the database.

§status: Option<String>

The current status of this DB cluster.

§endpoint: Option<String>

The connection endpoint for the primary instance of the DB cluster.

§reader_endpoint: Option<String>

The reader endpoint for the DB cluster.

§custom_endpoints: Option<Vec<String>>

A list of custom endpoints for the DB cluster.

§multi_az: Option<bool>

Whether the DB cluster has instances in multiple Availability Zones.

§engine: Option<String>

The name of the database engine to use for this DB cluster. Valid values are as follows:

  • aurora

  • aurora-mysql

  • aurora-postgresql

§engine_version: Option<String>

The version number of the database engine to use.

§port: Option<i32>

The port number on which the DB instances in the DB cluster accept connections.

§master_username: Option<String>

The name of the master user for the DB cluster.

§preferred_backup_window: Option<String>

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

§preferred_maintenance_window: Option<String>

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

Uses the 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.

§read_replica_identifiers: Option<Vec<String>>

The identifiers of the read replicas that are associated with this DB cluster.

§vpc_security_groups: Option<Vec<AwsRdsDbInstanceVpcSecurityGroup>>

A list of VPC security groups that the DB cluster belongs to.

§hosted_zone_id: Option<String>

Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.

§storage_encrypted: Option<bool>

Whether the DB cluster is encrypted.

§kms_key_id: Option<String>

The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.

§db_cluster_resource_id: Option<String>

The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.

§associated_roles: Option<Vec<AwsRdsDbClusterAssociatedRole>>

A list of the IAM roles that are associated with the DB cluster.

§cluster_create_time: Option<String>

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

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

§enabled_cloud_watch_logs_exports: Option<Vec<String>>

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

§engine_mode: Option<String>

The database engine mode of the DB cluster.Valid values are as follows:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

§deletion_protection: Option<bool>

Whether the DB cluster has deletion protection enabled.

§http_endpoint_enabled: Option<bool>

Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

§activity_stream_status: Option<String>

The status of the database activity stream. Valid values are as follows:

  • started

  • starting

  • stopped

  • stopping

§copy_tags_to_snapshot: Option<bool>

Whether tags are copied from the DB cluster to snapshots of the DB cluster.

§cross_account_clone: Option<bool>

Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

§domain_memberships: Option<Vec<AwsRdsDbDomainMembership>>

The Active Directory domain membership records that are associated with the DB cluster.

§db_cluster_parameter_group: Option<String>

The name of the DB cluster parameter group for the DB cluster.

§db_subnet_group: Option<String>

The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

§db_cluster_option_group_memberships: Option<Vec<AwsRdsDbClusterOptionGroupMembership>>

The list of option group memberships for this DB cluster.

§db_cluster_identifier: Option<String>

The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

§db_cluster_members: Option<Vec<AwsRdsDbClusterMember>>

The list of instances that make up the DB cluster.

§iam_database_authentication_enabled: Option<bool>

Whether the mapping of IAM accounts to database accounts is enabled.

§auto_minor_version_upgrade: Option<bool>

Indicates if minor version upgrades are automatically applied to the cluster.

Implementations§

Source§

impl AwsRdsDbClusterDetails

Source

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

For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

Source

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

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

Source

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

The number of days for which automated backups are retained.

Source

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

The name of the database.

Source

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

The current status of this DB cluster.

Source

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

The connection endpoint for the primary instance of the DB cluster.

Source

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

The reader endpoint for the DB cluster.

Source

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

A list of custom endpoints for the DB 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 .custom_endpoints.is_none().

Source

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

Whether the DB cluster has instances in multiple Availability Zones.

Source

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

The name of the database engine to use for this DB cluster. Valid values are as follows:

  • aurora

  • aurora-mysql

  • aurora-postgresql

Source

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

The version number of the database engine to use.

Source

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

The port number on which the DB instances in the DB cluster accept connections.

Source

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

The name of the master user for the DB cluster.

Source

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

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

Source

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

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

Uses the 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 read_replica_identifiers(&self) -> &[String]

The identifiers of the read replicas that are associated with this DB 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 .read_replica_identifiers.is_none().

Source

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

A list of VPC security groups that the DB cluster belongs to.

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 hosted_zone_id(&self) -> Option<&str>

Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.

Source

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

Whether the DB cluster is encrypted.

Source

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

The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.

Source

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

The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.

Source

pub fn associated_roles(&self) -> &[AwsRdsDbClusterAssociatedRole]

A list of the IAM roles that are associated with the DB 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 .associated_roles.is_none().

Source

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

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

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

Source

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

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

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

Source

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

The database engine mode of the DB cluster.Valid values are as follows:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

Source

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

Whether the DB cluster has deletion protection enabled.

Source

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

Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

Source

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

The status of the database activity stream. Valid values are as follows:

  • started

  • starting

  • stopped

  • stopping

Source

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

Whether tags are copied from the DB cluster to snapshots of the DB cluster.

Source

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

Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

Source

pub fn domain_memberships(&self) -> &[AwsRdsDbDomainMembership]

The Active Directory domain membership records that are associated with the DB 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 .domain_memberships.is_none().

Source

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

The name of the DB cluster parameter group for the DB cluster.

Source

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

The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

Source

pub fn db_cluster_option_group_memberships( &self, ) -> &[AwsRdsDbClusterOptionGroupMembership]

The list of option group memberships for this DB 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 .db_cluster_option_group_memberships.is_none().

Source

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

The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

Source

pub fn db_cluster_members(&self) -> &[AwsRdsDbClusterMember]

The list of instances that make up the DB 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 .db_cluster_members.is_none().

Source

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

Whether the mapping of IAM accounts to database accounts is enabled.

Source

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

Indicates if minor version upgrades are automatically applied to the cluster.

Source§

impl AwsRdsDbClusterDetails

Source

pub fn builder() -> AwsRdsDbClusterDetailsBuilder

Creates a new builder-style object to manufacture AwsRdsDbClusterDetails.

Trait Implementations§

Source§

impl Clone for AwsRdsDbClusterDetails

Source§

fn clone(&self) -> AwsRdsDbClusterDetails

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 AwsRdsDbClusterDetails

Source§

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

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

impl PartialEq for AwsRdsDbClusterDetails

Source§

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

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,