Skip to main content

UpdateAutonomousDatabaseInput

Struct UpdateAutonomousDatabaseInput 

Source
#[non_exhaustive]
pub struct UpdateAutonomousDatabaseInput {
Show 45 fields pub autonomous_database_id: Option<String>, pub admin_password: Option<String>, pub compute_count: Option<f64>, pub cpu_core_count: Option<i32>, pub data_storage_size_in_tbs: Option<i32>, pub data_storage_size_in_gbs: Option<i32>, pub display_name: Option<String>, pub db_name: Option<String>, pub db_version: Option<String>, pub db_workload: Option<DbWorkload>, pub db_tools_details: Option<Vec<DatabaseTool>>, pub database_edition: Option<DatabaseEdition>, pub license_model: Option<LicenseModel>, pub is_auto_scaling_enabled: Option<bool>, pub is_auto_scaling_for_storage_enabled: Option<bool>, pub is_backup_retention_locked: Option<bool>, pub is_local_data_guard_enabled: Option<bool>, pub is_mtls_connection_required: Option<bool>, pub is_refreshable_clone: Option<bool>, pub is_disconnect_peer: Option<bool>, pub backup_retention_period_in_days: Option<i32>, pub byol_compute_count_limit: Option<f64>, pub local_adg_auto_failover_max_data_loss_limit: Option<i32>, pub autonomous_maintenance_schedule_type: Option<AutonomousMaintenanceScheduleType>, pub customer_contacts_to_send_to_oci: Option<Vec<CustomerContact>>, pub scheduled_operations: Option<Vec<ScheduledOperationDetails>>, pub long_term_backup_schedule: Option<LongTermBackupSchedule>, pub open_mode: Option<OpenMode>, pub permission_level: Option<PermissionLevel>, pub refreshable_mode: Option<RefreshableMode>, pub private_endpoint_ip: Option<String>, pub private_endpoint_label: Option<String>, pub peer_db_id: Option<String>, pub resource_pool_leader_id: Option<String>, pub resource_pool_summary: Option<ResourcePoolSummary>, pub standby_allowlisted_ips_source: Option<StandbyAllowlistedIpsSource>, pub standby_allowlisted_ips: Option<Vec<String>>, pub allowlisted_ips: Option<Vec<String>>, pub auto_refresh_frequency_in_seconds: Option<i32>, pub auto_refresh_point_lag_in_seconds: Option<i32>, pub time_of_auto_refresh_start: Option<DateTime>, pub encryption_key_provider: Option<EncryptionKeyProviderInput>, pub encryption_key_configuration: Option<EncryptionKeyConfigurationInput>, pub admin_password_source: Option<AdminPasswordSource>, pub admin_password_source_configuration: Option<AdminPasswordSourceConfigurationInput>,
}

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

The unique identifier of the Autonomous Database to update.

§admin_password: Option<String>

The new password for the ADMIN user of the Autonomous Database.

§compute_count: Option<f64>

The compute capacity, in number of ECPUs or OCPUs, to assign to the Autonomous Database.

§cpu_core_count: Option<i32>

The number of CPU cores to allocate to the Autonomous Database.

§data_storage_size_in_tbs: Option<i32>

The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database.

§data_storage_size_in_gbs: Option<i32>

The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database.

§display_name: Option<String>

The new user-friendly name for the Autonomous Database.

§db_name: Option<String>

The new name of the Autonomous Database.

§db_version: Option<String>

The Oracle Database software version to use for the Autonomous Database.

§db_workload: Option<DbWorkload>

The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX.

§db_tools_details: Option<Vec<DatabaseTool>>

The list of database management tools to enable for the Autonomous Database.

§database_edition: Option<DatabaseEdition>

The Oracle Database edition to apply to the Autonomous Database.

§license_model: Option<LicenseModel>

The Oracle license model to apply to the Autonomous Database.

§is_auto_scaling_enabled: Option<bool>

Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.

§is_auto_scaling_for_storage_enabled: Option<bool>

Specifies whether to enable automatic scaling of the storage for the Autonomous Database.

§is_backup_retention_locked: Option<bool>

Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.

§is_local_data_guard_enabled: Option<bool>

Specifies whether to enable local Oracle Data Guard for the Autonomous Database.

§is_mtls_connection_required: Option<bool>

Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.

§is_refreshable_clone: Option<bool>

Specifies whether the Autonomous Database is a refreshable clone.

§is_disconnect_peer: Option<bool>

Specifies whether to disconnect the Autonomous Database from its peer database.

§backup_retention_period_in_days: Option<i32>

The retention period, in days, for automatic backups of the Autonomous Database.

§byol_compute_count_limit: Option<f64>

The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.

§local_adg_auto_failover_max_data_loss_limit: Option<i32>

The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database.

§autonomous_maintenance_schedule_type: Option<AutonomousMaintenanceScheduleType>

The maintenance schedule type for the Autonomous Database.

§customer_contacts_to_send_to_oci: Option<Vec<CustomerContact>>

The list of customer contacts to receive operational notifications from OCI for the Autonomous Database.

§scheduled_operations: Option<Vec<ScheduledOperationDetails>>

The list of scheduled start and stop times for the Autonomous Database.

§long_term_backup_schedule: Option<LongTermBackupSchedule>

The long-term backup schedule for the Autonomous Database.

§open_mode: Option<OpenMode>

The mode in which to open the Autonomous Database, either read-only or read/write.

§permission_level: Option<PermissionLevel>

The permission level of the Autonomous Database.

§refreshable_mode: Option<RefreshableMode>

The refresh mode of the refreshable clone Autonomous Database.

§private_endpoint_ip: Option<String>

The private endpoint IP address for the Autonomous Database.

§private_endpoint_label: Option<String>

The private endpoint label for the Autonomous Database.

§peer_db_id: Option<String>

The unique identifier of the peer Autonomous Database.

§resource_pool_leader_id: Option<String>

The unique identifier of the resource pool leader Autonomous Database.

§resource_pool_summary: Option<ResourcePoolSummary>

The configuration of the resource pool for the Autonomous Database.

§standby_allowlisted_ips_source: Option<StandbyAllowlistedIpsSource>

The source of the allowlisted IP addresses for the standby Autonomous Database.

§standby_allowlisted_ips: Option<Vec<String>>

The list of IP addresses that are allowed to access the standby Autonomous Database.

§allowlisted_ips: Option<Vec<String>>

The list of IP addresses that are allowed to access the Autonomous Database.

§auto_refresh_frequency_in_seconds: Option<i32>

The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed.

§auto_refresh_point_lag_in_seconds: Option<i32>

The time lag, in seconds, between the refreshable clone and its source Autonomous Database.

§time_of_auto_refresh_start: Option<DateTime>

The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts.

§encryption_key_provider: Option<EncryptionKeyProviderInput>

The provider of the encryption key to use for the Autonomous Database.

§encryption_key_configuration: Option<EncryptionKeyConfigurationInput>

The configuration of the encryption key to use for the Autonomous Database.

§admin_password_source: Option<AdminPasswordSource>

The source of the admin password for the Autonomous Database. When set to CUSTOMER_MANAGED_AWS_SECRET, the admin password is retrieved from an Amazon Web Services Secrets Manager secret.

§admin_password_source_configuration: Option<AdminPasswordSourceConfigurationInput>

The configuration of the admin password source for the Autonomous Database.

Implementations§

Source§

impl UpdateAutonomousDatabaseInput

Source

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

The unique identifier of the Autonomous Database to update.

Source

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

The new password for the ADMIN user of the Autonomous Database.

Source

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

The compute capacity, in number of ECPUs or OCPUs, to assign to the Autonomous Database.

Source

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

The number of CPU cores to allocate to the Autonomous Database.

Source

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

The size, in terabytes (TB), of the data volume to allocate for the Autonomous Database.

Source

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

The size, in gigabytes (GB), of the data volume to allocate for the Autonomous Database.

Source

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

The new user-friendly name for the Autonomous Database.

Source

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

The new name of the Autonomous Database.

Source

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

The Oracle Database software version to use for the Autonomous Database.

Source

pub fn db_workload(&self) -> Option<&DbWorkload>

The intended use of the Autonomous Database, such as transaction processing, data warehouse, JSON database, or APEX.

Source

pub fn db_tools_details(&self) -> &[DatabaseTool]

The list of database management tools to enable for the Autonomous Database.

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

Source

pub fn database_edition(&self) -> Option<&DatabaseEdition>

The Oracle Database edition to apply to the Autonomous Database.

Source

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

The Oracle license model to apply to the Autonomous Database.

Source

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

Specifies whether to enable automatic scaling of the compute resources for the Autonomous Database.

Source

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

Specifies whether to enable automatic scaling of the storage for the Autonomous Database.

Source

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

Specifies whether to lock the backup retention period of the Autonomous Database to prevent it from being shortened.

Source

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

Specifies whether to enable local Oracle Data Guard for the Autonomous Database.

Source

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

Specifies whether mutual TLS (mTLS) authentication is required to connect to the Autonomous Database.

Source

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

Specifies whether the Autonomous Database is a refreshable clone.

Source

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

Specifies whether to disconnect the Autonomous Database from its peer database.

Source

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

The retention period, in days, for automatic backups of the Autonomous Database.

Source

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

The maximum number of compute resources that you can allocate to the Autonomous Database under the bring-your-own-license (BYOL) model.

Source

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

The maximum data loss limit, in seconds, for automatic failover to the local Oracle Data Guard standby database.

Source

pub fn autonomous_maintenance_schedule_type( &self, ) -> Option<&AutonomousMaintenanceScheduleType>

The maintenance schedule type for the Autonomous Database.

Source

pub fn customer_contacts_to_send_to_oci(&self) -> &[CustomerContact]

The list of customer contacts to receive operational notifications from OCI for the Autonomous Database.

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

Source

pub fn scheduled_operations(&self) -> &[ScheduledOperationDetails]

The list of scheduled start and stop times for the Autonomous Database.

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

Source

pub fn long_term_backup_schedule(&self) -> Option<&LongTermBackupSchedule>

The long-term backup schedule for the Autonomous Database.

Source

pub fn open_mode(&self) -> Option<&OpenMode>

The mode in which to open the Autonomous Database, either read-only or read/write.

Source

pub fn permission_level(&self) -> Option<&PermissionLevel>

The permission level of the Autonomous Database.

Source

pub fn refreshable_mode(&self) -> Option<&RefreshableMode>

The refresh mode of the refreshable clone Autonomous Database.

Source

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

The private endpoint IP address for the Autonomous Database.

Source

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

The private endpoint label for the Autonomous Database.

Source

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

The unique identifier of the peer Autonomous Database.

Source

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

The unique identifier of the resource pool leader Autonomous Database.

Source

pub fn resource_pool_summary(&self) -> Option<&ResourcePoolSummary>

The configuration of the resource pool for the Autonomous Database.

Source

pub fn standby_allowlisted_ips_source( &self, ) -> Option<&StandbyAllowlistedIpsSource>

The source of the allowlisted IP addresses for the standby Autonomous Database.

Source

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

The list of IP addresses that are allowed to access the standby Autonomous Database.

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

Source

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

The list of IP addresses that are allowed to access the Autonomous Database.

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

Source

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

The frequency, in seconds, at which the refreshable clone Autonomous Database is automatically refreshed.

Source

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

The time lag, in seconds, between the refreshable clone and its source Autonomous Database.

Source

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

The date and time at which the automatic refresh of the refreshable clone Autonomous Database starts.

Source

pub fn encryption_key_provider(&self) -> Option<&EncryptionKeyProviderInput>

The provider of the encryption key to use for the Autonomous Database.

Source

pub fn encryption_key_configuration( &self, ) -> Option<&EncryptionKeyConfigurationInput>

The configuration of the encryption key to use for the Autonomous Database.

Source

pub fn admin_password_source(&self) -> Option<&AdminPasswordSource>

The source of the admin password for the Autonomous Database. When set to CUSTOMER_MANAGED_AWS_SECRET, the admin password is retrieved from an Amazon Web Services Secrets Manager secret.

Source

pub fn admin_password_source_configuration( &self, ) -> Option<&AdminPasswordSourceConfigurationInput>

The configuration of the admin password source for the Autonomous Database.

Source§

impl UpdateAutonomousDatabaseInput

Source

pub fn builder() -> UpdateAutonomousDatabaseInputBuilder

Creates a new builder-style object to manufacture UpdateAutonomousDatabaseInput.

Trait Implementations§

Source§

impl Clone for UpdateAutonomousDatabaseInput

Source§

fn clone(&self) -> UpdateAutonomousDatabaseInput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for UpdateAutonomousDatabaseInput

Source§

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

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

impl PartialEq for UpdateAutonomousDatabaseInput

Source§

fn eq(&self, other: &UpdateAutonomousDatabaseInput) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for UpdateAutonomousDatabaseInput

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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