DbInstance

aws_sdk_neptune::types

Struct DbInstance 

Source 
#[non_exhaustive]
pub struct DbInstance {
Show 53 fields
    pub db_instance_identifier: Option<String>,
    pub db_instance_class: Option<String>,
    pub engine: Option<String>,
    pub db_instance_status: Option<String>,
    pub master_username: Option<String>,
    pub db_name: Option<String>,
    pub endpoint: Option<Endpoint>,
    pub allocated_storage: Option<i32>,
    pub instance_create_time: Option<DateTime>,
    pub preferred_backup_window: Option<String>,
    pub backup_retention_period: Option<i32>,
    pub db_security_groups: Option<Vec<DbSecurityGroupMembership>>,
    pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>,
    pub db_parameter_groups: Option<Vec<DbParameterGroupStatus>>,
    pub availability_zone: Option<String>,
    pub db_subnet_group: Option<DbSubnetGroup>,
    pub preferred_maintenance_window: Option<String>,
    pub pending_modified_values: Option<PendingModifiedValues>,
    pub latest_restorable_time: Option<DateTime>,
    pub multi_az: Option<bool>,
    pub engine_version: Option<String>,
    pub auto_minor_version_upgrade: Option<bool>,
    pub read_replica_source_db_instance_identifier: Option<String>,
    pub read_replica_db_instance_identifiers: Option<Vec<String>>,
    pub read_replica_db_cluster_identifiers: Option<Vec<String>>,
    pub license_model: Option<String>,
    pub iops: Option<i32>,
    pub option_group_memberships: Option<Vec<OptionGroupMembership>>,
    pub character_set_name: Option<String>,
    pub secondary_availability_zone: Option<String>,
    pub publicly_accessible: Option<bool>,
    pub status_infos: Option<Vec<DbInstanceStatusInfo>>,
    pub storage_type: Option<String>,
    pub tde_credential_arn: Option<String>,
    pub db_instance_port: Option<i32>,
    pub db_cluster_identifier: Option<String>,
    pub storage_encrypted: Option<bool>,
    pub kms_key_id: Option<String>,
    pub dbi_resource_id: Option<String>,
    pub ca_certificate_identifier: Option<String>,
    pub domain_memberships: Option<Vec<DomainMembership>>,
    pub copy_tags_to_snapshot: Option<bool>,
    pub monitoring_interval: Option<i32>,
    pub enhanced_monitoring_resource_arn: Option<String>,
    pub monitoring_role_arn: Option<String>,
    pub promotion_tier: Option<i32>,
    pub db_instance_arn: Option<String>,
    pub timezone: Option<String>,
    pub iam_database_authentication_enabled: Option<bool>,
    pub performance_insights_enabled: Option<bool>,
    pub performance_insights_kms_key_id: Option<String>,
    pub enabled_cloudwatch_logs_exports: Option<Vec<String>>,
    pub deletion_protection: Option<bool>,

}
Expand description

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances action.

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.
§db_instance_identifier: Option<String>

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

§db_instance_class: Option<String>

Contains the name of the compute and memory capacity class of the DB instance.

§engine: Option<String>

Provides the name of the database engine to be used for this DB instance.

§db_instance_status: Option<String>

Specifies the current state of this database.

§master_username: Option<String>

Not supported by Neptune.

§db_name: Option<String>

The database name.

§endpoint: Option<Endpoint>

Specifies the connection endpoint.

§allocated_storage: Option<i32>

Not supported by Neptune.

§instance_create_time: Option<DateTime>

Provides the date and time the DB instance was created.

§preferred_backup_window: Option<String>

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

§backup_retention_period: Option<i32>

Specifies the number of days for which automatic DB snapshots are retained.

§db_security_groups: Option<Vec<DbSecurityGroupMembership>>

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

§vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>

Provides a list of VPC security group elements that the DB instance belongs to.

§db_parameter_groups: Option<Vec<DbParameterGroupStatus>>

Provides the list of DB parameter groups applied to this DB instance.

§availability_zone: Option<String>

Specifies the name of the Availability Zone the DB instance is located in.

§db_subnet_group: Option<DbSubnetGroup>

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

§preferred_maintenance_window: Option<String>

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

§pending_modified_values: Option<PendingModifiedValues>

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

§latest_restorable_time: Option<DateTime>

Specifies the latest time to which a database can be restored with point-in-time restore.

§multi_az: Option<bool>

Specifies if the DB instance is a Multi-AZ deployment.

§engine_version: Option<String>

Indicates the database engine version.

§auto_minor_version_upgrade: Option<bool>

Indicates that minor version patches are applied automatically.

§read_replica_source_db_instance_identifier: Option<String>

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

§read_replica_db_instance_identifiers: Option<Vec<String>>

Contains one or more identifiers of the Read Replicas associated with this DB instance.

§read_replica_db_cluster_identifiers: Option<Vec<String>>

Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

§license_model: Option<String>

License model information for this DB instance.

§iops: Option<i32>

Specifies the Provisioned IOPS (I/O operations per second) value.

§option_group_memberships: Option<Vec<OptionGroupMembership>>

(Not supported by Neptune)

§character_set_name: Option<String>

(Not supported by Neptune)

§secondary_availability_zone: Option<String>

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

§publicly_accessible: Option<bool>

Indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

§status_infos: Option<Vec<DbInstanceStatusInfo>>

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

§storage_type: Option<String>

Specifies the storage type associated with the DB instance.

§tde_credential_arn: Option<String>

The ARN from the key store with which the instance is associated for TDE encryption.

§db_instance_port: Option<i32>

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

§db_cluster_identifier: Option<String>

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

§storage_encrypted: Option<bool>

Not supported: The encryption for DB instances is managed by the DB cluster.

§kms_key_id: Option<String>

Not supported: The encryption for DB instances is managed by the DB cluster.

§dbi_resource_id: Option<String>

The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed.

§ca_certificate_identifier: Option<String>

The identifier of the CA certificate for this DB instance.

§domain_memberships: Option<Vec<DomainMembership>>

Not supported

§copy_tags_to_snapshot: Option<bool>

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

§monitoring_interval: Option<i32>

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

§enhanced_monitoring_resource_arn: Option<String>

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

§monitoring_role_arn: Option<String>

The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

§promotion_tier: Option<i32>

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

§db_instance_arn: Option<String>

The Amazon Resource Name (ARN) for the DB instance.

§timezone: Option<String>

Not supported.

§iam_database_authentication_enabled: Option<bool>

True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

§performance_insights_enabled: Option<bool>

(Not supported by Neptune)

§performance_insights_kms_key_id: Option<String>

(Not supported by Neptune)

§enabled_cloudwatch_logs_exports: Option<Vec<String>>

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

§deletion_protection: Option<bool>

Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.

Implementations§

Source§

impl DbInstance

Source

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

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Source

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

Contains the name of the compute and memory capacity class of the DB instance.

Source

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

Provides the name of the database engine to be used for this DB instance.

Source

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

Specifies the current state of this database.

Source

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

Not supported by Neptune.

Source

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

The database name.

Source

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

Specifies the connection endpoint.

Source

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

Not supported by Neptune.

Source

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

Provides the date and time the DB instance was created.

Source

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

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Source

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

Specifies the number of days for which automatic DB snapshots are retained.

Source

pub fn db_security_groups(&self) -> &[DbSecurityGroupMembership]

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

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_security_groups.is_none().

Source

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

Provides a list of VPC security group elements that the DB instance 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 db_parameter_groups(&self) -> &[DbParameterGroupStatus]

Provides the list of DB parameter groups applied to this DB instance.

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_parameter_groups.is_none().

Source

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

Specifies the name of the Availability Zone the DB instance is located in.

Source

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

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Source

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

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

Source

pub fn pending_modified_values(&self) -> Option<&PendingModifiedValues>

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Source

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

Specifies the latest time to which a database can be restored with point-in-time restore.

Source

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

Specifies if the DB instance is a Multi-AZ deployment.

Source

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

Indicates the database engine version.

Source

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

Indicates that minor version patches are applied automatically.

Source

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

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

Source

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

Contains one or more identifiers of the Read Replicas associated with this DB instance.

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_db_instance_identifiers.is_none().

Source

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

Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

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_db_cluster_identifiers.is_none().

Source

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

License model information for this DB instance.

Source

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

Specifies the Provisioned IOPS (I/O operations per second) value.

Source

pub fn option_group_memberships(&self) -> &[OptionGroupMembership]

(Not supported by Neptune)

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

Source

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

(Not supported by Neptune)

Source

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

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Source

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

Indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

Source

pub fn status_infos(&self) -> &[DbInstanceStatusInfo]

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

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

Source

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

Specifies the storage type associated with the DB instance.

Source

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

The ARN from the key store with which the instance is associated for TDE encryption.

Source

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

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

Source

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

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Source

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

Not supported: The encryption for DB instances is managed by the DB cluster.

Source

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

Not supported: The encryption for DB instances is managed by the DB cluster.

Source

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

The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed.

Source

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

The identifier of the CA certificate for this DB instance.

Source

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

Not supported

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 copy_tags_to_snapshot(&self) -> Option<bool>

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Source

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

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

Source

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

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Source

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

The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Source

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

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

Source

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

The Amazon Resource Name (ARN) for the DB instance.

Source

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

Not supported.

Source

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

True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

Source

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

(Not supported by Neptune)

Source

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

(Not supported by Neptune)

Source

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

A list of log types that this DB instance 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_cloudwatch_logs_exports.is_none().

Source

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

Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.

Source§

impl DbInstance

Source

pub fn builder() -> DbInstanceBuilder

Creates a new builder-style object to manufacture DbInstance.

Trait Implementations§

Source§

impl Clone for DbInstance

Source§

fn clone(&self) -> DbInstance

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 DbInstance

Source§

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

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

impl PartialEq for DbInstance

Source§

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

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