Skip to main content

CreateAutonomousDatabaseFluentBuilder

aws_sdk_odb::operation::create_autonomous_database::builders

Struct CreateAutonomousDatabaseFluentBuilder 

Source 
pub struct CreateAutonomousDatabaseFluentBuilder { /* private fields */ }
Expand description

Fluent builder constructing a request to CreateAutonomousDatabase.

Creates a new Autonomous Database.

Implementations§

Source§

impl CreateAutonomousDatabaseFluentBuilder

Source

pub fn as_input(&self) -> &CreateAutonomousDatabaseInputBuilder

Access the CreateAutonomousDatabase as a reference.

Source

pub async fn send( self, ) -> Result<CreateAutonomousDatabaseOutput, SdkError<CreateAutonomousDatabaseError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

Source

pub fn customize( self, ) -> CustomizableOperation<CreateAutonomousDatabaseOutput, CreateAutonomousDatabaseError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

Source

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

The unique identifier of the ODB network to be used for the Autonomous Database.

Source

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

The unique identifier of the ODB network to be used for the Autonomous Database.

Source

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

The unique identifier of the ODB network to be used for the Autonomous Database.

Source

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

The user-friendly name for the Autonomous Database. The name does not have to be unique.

Source

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

The user-friendly name for the Autonomous Database. The name does not have to be unique.

Source

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

The user-friendly name for the Autonomous Database. The name does not have to be unique.

Source

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

The name of the Autonomous Database. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The name must be unique in the Amazon Web Services account.

Source

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

The name of the Autonomous Database. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The name must be unique in the Amazon Web Services account.

Source

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

The name of the Autonomous Database. The name must begin with an alphabetic character and can contain a maximum of 30 alphanumeric characters. Special characters are not permitted. The name must be unique in the Amazon Web Services account.

Source

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

The password for the ADMIN user of the Autonomous Database.

Source

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

The password for the ADMIN user of the Autonomous Database.

Source

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

The password for the ADMIN user of the Autonomous Database.

Source

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

The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), to assign to the Autonomous Database.

Source

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

The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), to assign to the Autonomous Database.

Source

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

The compute capacity, in number of Elastic CPUs (ECPUs) or Oracle CPUs (OCPUs), to assign to the Autonomous Database.

Source

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

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

Source

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

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

Source

pub fn get_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, input: i32) -> Self

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

Source

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

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

Source

pub fn get_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 db_workload(self, input: DbWorkload) -> Self

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

Source

pub fn set_db_workload(self, input: Option<DbWorkload>) -> Self

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

Source

pub fn get_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 is_auto_scaling_enabled(self, input: bool) -> Self

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

Source

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

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

Source

pub fn get_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, input: bool) -> Self

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

Source

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

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

Source

pub fn get_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 license_model(self, input: LicenseModel) -> Self

The Oracle license model to apply to the Autonomous Database.

Source

pub fn set_license_model(self, input: Option<LicenseModel>) -> Self

The Oracle license model to apply to the Autonomous Database.

Source

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

The Oracle license model to apply to the Autonomous Database.

Source

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

The character set to use for the Autonomous Database.

Source

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

The character set to use for the Autonomous Database.

Source

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

The character set to use for the Autonomous Database.

Source

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

The national character set to use for the Autonomous Database.

Source

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

The national character set to use for the Autonomous Database.

Source

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

The national character set to use for the Autonomous Database.

Source

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

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

Source

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

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

Source

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

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

Source

pub fn database_edition(self, input: DatabaseEdition) -> Self

The Oracle Database edition to apply to the Autonomous Database.

Source

pub fn set_database_edition(self, input: Option<DatabaseEdition>) -> Self

The Oracle Database edition to apply to the Autonomous Database.

Source

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

The Oracle Database edition to apply to the Autonomous Database.

Source

pub fn standby_allowlisted_ips_source( self, input: StandbyAllowlistedIpsSource, ) -> Self

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

Source

pub fn set_standby_allowlisted_ips_source( self, input: Option<StandbyAllowlistedIpsSource>, ) -> Self

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

Source

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

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

Source

pub fn autonomous_maintenance_schedule_type( self, input: AutonomousMaintenanceScheduleType, ) -> Self

The maintenance schedule type for the Autonomous Database.

Source

pub fn set_autonomous_maintenance_schedule_type( self, input: Option<AutonomousMaintenanceScheduleType>, ) -> Self

The maintenance schedule type for the Autonomous Database.

Source

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

The maintenance schedule type for the Autonomous Database.

Source

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

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

Source

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

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

Source

pub fn get_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, input: f64) -> Self

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 set_byol_compute_count_limit(self, input: Option<f64>) -> Self

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 get_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 cpu_core_count(self, input: i32) -> Self

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

Source

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

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

Source

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

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

Source

pub fn customer_contacts_to_send_to_oci(self, input: CustomerContact) -> Self

Appends an item to customerContactsToSendToOCI.

To override the contents of this collection use set_customer_contacts_to_send_to_oci.

The list of customer contacts to receive operational notifications from Oracle Cloud Infrastructure (OCI) for the Autonomous Database.

Source

pub fn set_customer_contacts_to_send_to_oci( self, input: Option<Vec<CustomerContact>>, ) -> Self

The list of customer contacts to receive operational notifications from Oracle Cloud Infrastructure (OCI) for the Autonomous Database.

Source

pub fn get_customer_contacts_to_send_to_oci( &self, ) -> &Option<Vec<CustomerContact>>

The list of customer contacts to receive operational notifications from Oracle Cloud Infrastructure (OCI) for the Autonomous Database.

Source

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

The private endpoint IP address for the Autonomous Database.

Source

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

The private endpoint IP address for the Autonomous Database.

Source

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

The private endpoint IP address for the Autonomous Database.

Source

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

The private endpoint label for the Autonomous Database.

Source

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

The private endpoint label for the Autonomous Database.

Source

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

The private endpoint label for the Autonomous Database.

Source

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

The unique identifier of the resource pool leader Autonomous Database.

Source

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

The unique identifier of the resource pool leader Autonomous Database.

Source

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

The unique identifier of the resource pool leader Autonomous Database.

Source

pub fn resource_pool_summary(self, input: ResourcePoolSummary) -> Self

The configuration of the resource pool for the Autonomous Database.

Source

pub fn set_resource_pool_summary( self, input: Option<ResourcePoolSummary>, ) -> Self

The configuration of the resource pool for the Autonomous Database.

Source

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

The configuration of the resource pool for the Autonomous Database.

Source

pub fn scheduled_operations(self, input: ScheduledOperationDetails) -> Self

Appends an item to scheduledOperations.

To override the contents of this collection use set_scheduled_operations.

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

Source

pub fn set_scheduled_operations( self, input: Option<Vec<ScheduledOperationDetails>>, ) -> Self

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

Source

pub fn get_scheduled_operations( &self, ) -> &Option<Vec<ScheduledOperationDetails>>

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

Source

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

Appends an item to standbyAllowlistedIps.

To override the contents of this collection use set_standby_allowlisted_ips.

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

Source

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

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

Source

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

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

Source

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

Appends an item to allowlistedIps.

To override the contents of this collection use set_allowlisted_ips.

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

Source

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

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

Source

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

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

Source

pub fn transportable_tablespace(self, input: TransportableTablespace) -> Self

The transportable tablespace configuration to use when creating the Autonomous Database.

Source

pub fn set_transportable_tablespace( self, input: Option<TransportableTablespace>, ) -> Self

The transportable tablespace configuration to use when creating the Autonomous Database.

Source

pub fn get_transportable_tablespace(&self) -> &Option<TransportableTablespace>

The transportable tablespace configuration to use when creating the Autonomous Database.

Source

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

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

Source

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

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

Source

pub fn get_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, input: bool) -> Self

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

Source

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

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

Source

pub fn get_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, input: bool) -> Self

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

Source

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

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

Source

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

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

Source

pub fn db_tools_details(self, input: DatabaseTool) -> Self

Appends an item to dbToolsDetails.

To override the contents of this collection use set_db_tools_details.

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

Source

pub fn set_db_tools_details(self, input: Option<Vec<DatabaseTool>>) -> Self

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

Source

pub fn get_db_tools_details(&self) -> &Option<Vec<DatabaseTool>>

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

Source

pub fn source(self, input: SourceType) -> Self

The source from which to create the Autonomous Database, such as a clone, backup, or cross-Region copy.

Source

pub fn set_source(self, input: Option<SourceType>) -> Self

The source from which to create the Autonomous Database, such as a clone, backup, or cross-Region copy.

Source

pub fn get_source(&self) -> &Option<SourceType>

The source from which to create the Autonomous Database, such as a clone, backup, or cross-Region copy.

Source

pub fn source_configuration(self, input: SourceConfiguration) -> Self

The configuration details for the source used to create the Autonomous Database.

Source

pub fn set_source_configuration( self, input: Option<SourceConfiguration>, ) -> Self

The configuration details for the source used to create the Autonomous Database.

Source

pub fn get_source_configuration(&self) -> &Option<SourceConfiguration>

The configuration details for the source used to create the Autonomous Database.

Source

pub fn encryption_key_provider(self, input: EncryptionKeyProviderInput) -> Self

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

Source

pub fn set_encryption_key_provider( self, input: Option<EncryptionKeyProviderInput>, ) -> Self

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

Source

pub fn get_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, input: EncryptionKeyConfigurationInput, ) -> Self

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

Source

pub fn set_encryption_key_configuration( self, input: Option<EncryptionKeyConfigurationInput>, ) -> Self

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

Source

pub fn get_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, input: AdminPasswordSource) -> Self

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 set_admin_password_source( self, input: Option<AdminPasswordSource>, ) -> Self

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 get_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, input: AdminPasswordSourceConfigurationInput, ) -> Self

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

Source

pub fn set_admin_password_source_configuration( self, input: Option<AdminPasswordSourceConfigurationInput>, ) -> Self

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

Source

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

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

Source

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

A client-provided token to ensure the idempotency of the request.

Source

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

A client-provided token to ensure the idempotency of the request.

Source

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

A client-provided token to ensure the idempotency of the request.

Source

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The list of resource tags to apply to the Autonomous Database. Each tag is a key-value pair with no predefined name, type, or namespace.

Source

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

The list of resource tags to apply to the Autonomous Database. Each tag is a key-value pair with no predefined name, type, or namespace.

Source

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

The list of resource tags to apply to the Autonomous Database. Each tag is a key-value pair with no predefined name, type, or namespace.

Trait Implementations§

Source§

impl Clone for CreateAutonomousDatabaseFluentBuilder

Source§

fn clone(&self) -> CreateAutonomousDatabaseFluentBuilder

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 CreateAutonomousDatabaseFluentBuilder

Source§

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

Formats the value using the given formatter. Read more

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