aws_sdk_odb::types::builders

Struct CloudExadataInfrastructureBuilder

#[non_exhaustive]
pub struct CloudExadataInfrastructureBuilder { /* private fields */ }

Expand description

A builder for CloudExadataInfrastructure.

Implementations§

impl CloudExadataInfrastructureBuilder

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

The unique identifier for the Exadata infrastructure.

This field is required.

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

The unique identifier for the Exadata infrastructure.

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

The unique identifier for the Exadata infrastructure.

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

The user-friendly name for the Exadata infrastructure.

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

The user-friendly name for the Exadata infrastructure.

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

The user-friendly name for the Exadata infrastructure.

pub fn status(self, input: ResourceStatus) -> Self

The current status of the Exadata infrastructure.

pub fn set_status(self, input: Option<ResourceStatus>) -> Self

The current status of the Exadata infrastructure.

pub fn get_status(&self) -> &Option<ResourceStatus>

The current status of the Exadata infrastructure.

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

Additional information about the status of the Exadata infrastructure.

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

Additional information about the status of the Exadata infrastructure.

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

Additional information about the status of the Exadata infrastructure.

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

The Amazon Resource Name (ARN) for the Exadata infrastructure.

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

The Amazon Resource Name (ARN) for the Exadata infrastructure.

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

The Amazon Resource Name (ARN) for the Exadata infrastructure.

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

The number of storage servers requested for the Exadata infrastructure.

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

The number of storage servers requested for the Exadata infrastructure.

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

The number of storage servers requested for the Exadata infrastructure.

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

The number of storage servers requested for the Exadata infrastructure.

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

The number of storage servers requested for the Exadata infrastructure.

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

The number of storage servers requested for the Exadata infrastructure.

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

The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.

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

The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.

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

The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.

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

The name of the Availability Zone (AZ) where the Exadata infrastructure is located.

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

The name of the Availability Zone (AZ) where the Exadata infrastructure is located.

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

The name of the Availability Zone (AZ) where the Exadata infrastructure is located.

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

The AZ ID of the AZ where the Exadata infrastructure is located.

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

The AZ ID of the AZ where the Exadata infrastructure is located.

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

The AZ ID of the AZ where the Exadata infrastructure is located.

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

The number of database servers for the Exadata infrastructure.

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

The number of database servers for the Exadata infrastructure.

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

The number of database servers for the Exadata infrastructure.

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

The total number of CPU cores that are allocated to the Exadata infrastructure.

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

The total number of CPU cores that are allocated to the Exadata infrastructure.

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

The total number of CPU cores that are allocated to the Exadata infrastructure.

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

Appends an item to customer_contacts_to_send_to_oci.

To override the contents of this collection use set_customer_contacts_to_send_to_oci.

The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.

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

The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.

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

The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.

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

The size of the Exadata infrastructure's data disk group, in terabytes (TB).

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

The size of the Exadata infrastructure's data disk group, in terabytes (TB).

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

The size of the Exadata infrastructure's data disk group, in terabytes (TB).

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

The size of the Exadata infrastructure's local node storage, in gigabytes (GB).

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

The size of the Exadata infrastructure's local node storage, in gigabytes (GB).

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

The size of the Exadata infrastructure's local node storage, in gigabytes (GB).

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

The software version of the database servers (dom0) in the Exadata infrastructure.

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

The software version of the database servers (dom0) in the Exadata infrastructure.

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

The software version of the database servers (dom0) in the Exadata infrastructure.

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

The Oracle Cloud Identifier (OCID) of the last maintenance run for the Exadata infrastructure.

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

The Oracle Cloud Identifier (OCID) of the last maintenance run for the Exadata infrastructure.

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

The Oracle Cloud Identifier (OCID) of the last maintenance run for the Exadata infrastructure.

pub fn maintenance_window(self, input: MaintenanceWindow) -> Self

The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.

pub fn set_maintenance_window(self, input: Option<MaintenanceWindow>) -> Self

The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.

pub fn get_maintenance_window(&self) -> &Option<MaintenanceWindow>

The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.

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

The total number of CPU cores available on the Exadata infrastructure.

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

The total number of CPU cores available on the Exadata infrastructure.

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

The total number of CPU cores available on the Exadata infrastructure.

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

The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.

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

The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.

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

The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.

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

The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.

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

The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.

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

The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.

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

The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.

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

The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.

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

The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.

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

The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.

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

The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.

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

The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.

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

The monthly software version of the database servers installed on the Exadata infrastructure.

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

The monthly software version of the database servers installed on the Exadata infrastructure.

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

The monthly software version of the database servers installed on the Exadata infrastructure.

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

The monthly software version of the storage servers installed on the Exadata infrastructure.

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

The monthly software version of the storage servers installed on the Exadata infrastructure.

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

The monthly software version of the storage servers installed on the Exadata infrastructure.

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

The OCID of the next maintenance run for the Exadata infrastructure.

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

The OCID of the next maintenance run for the Exadata infrastructure.

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

The OCID of the next maintenance run for the Exadata infrastructure.

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

The name of the OCI resource anchor for the Exadata infrastructure.

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

The name of the OCI resource anchor for the Exadata infrastructure.

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

The name of the OCI resource anchor for the Exadata infrastructure.

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

The HTTPS link to the Exadata infrastructure in OCI.

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

The HTTPS link to the Exadata infrastructure in OCI.

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

The HTTPS link to the Exadata infrastructure in OCI.

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

The OCID of the Exadata infrastructure.

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

The OCID of the Exadata infrastructure.

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

The OCID of the Exadata infrastructure.

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

The model name of the Exadata infrastructure.

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

The model name of the Exadata infrastructure.

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

The model name of the Exadata infrastructure.

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

The number of storage servers that are activated for the Exadata infrastructure.

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

The number of storage servers that are activated for the Exadata infrastructure.

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

The number of storage servers that are activated for the Exadata infrastructure.

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

The software version of the storage servers on the Exadata infrastructure.

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

The software version of the storage servers on the Exadata infrastructure.

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

The software version of the storage servers on the Exadata infrastructure.

pub fn created_at(self, input: DateTime) -> Self

The date and time when the Exadata infrastructure was created.

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The date and time when the Exadata infrastructure was created.

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

The date and time when the Exadata infrastructure was created.

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

The total amount of storage, in gigabytes (GB), on the the Exadata infrastructure.

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

The total amount of storage, in gigabytes (GB), on the the Exadata infrastructure.

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

The total amount of storage, in gigabytes (GB), on the the Exadata infrastructure.

pub fn percent_progress(self, input: f32) -> Self

The amount of progress made on the current operation on the Exadata infrastructure, expressed as a percentage.

pub fn set_percent_progress(self, input: Option<f32>) -> Self

The amount of progress made on the current operation on the Exadata infrastructure, expressed as a percentage.

pub fn get_percent_progress(&self) -> &Option<f32>

The amount of progress made on the current operation on the Exadata infrastructure, expressed as a percentage.

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

The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.

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

The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.

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

The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.

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

The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.

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

The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.

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

The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.

pub fn compute_model(self, input: ComputeModel) -> Self

The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.

pub fn set_compute_model(self, input: Option<ComputeModel>) -> Self

The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.

pub fn get_compute_model(&self) -> &Option<ComputeModel>

The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.

pub fn build(self) -> Result<CloudExadataInfrastructure, BuildError>

Consumes the builder and constructs a CloudExadataInfrastructure. This method will fail if any of the following fields are not set:

cloud_exadata_infrastructure_id

Trait Implementations§

impl Clone for CloudExadataInfrastructureBuilder

fn clone(&self) -> CloudExadataInfrastructureBuilder

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for CloudExadataInfrastructureBuilder

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

Formats the value using the given formatter. Read more

impl Default for CloudExadataInfrastructureBuilder

fn default() -> CloudExadataInfrastructureBuilder

Returns the “default value” for a type. Read more

impl PartialEq for CloudExadataInfrastructureBuilder

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CloudExadataInfrastructureBuilder

Auto Trait Implementations§

impl Freeze for CloudExadataInfrastructureBuilder

impl RefUnwindSafe for CloudExadataInfrastructureBuilder

impl Send for CloudExadataInfrastructureBuilder

impl Sync for CloudExadataInfrastructureBuilder

impl Unpin for CloudExadataInfrastructureBuilder

impl UnwindSafe for CloudExadataInfrastructureBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T> Paint for T
where T: ?Sized,

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();

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example

println!("{}", value.primary());

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example

println!("{}", value.fixed(color));

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));

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example

println!("{}", value.black());

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example

println!("{}", value.red());

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example

println!("{}", value.green());

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example

println!("{}", value.yellow());

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example

println!("{}", value.blue());

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example

println!("{}", value.magenta());

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example

println!("{}", value.cyan());

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example

println!("{}", value.white());

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example

println!("{}", value.bright_black());

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example

println!("{}", value.bright_red());

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example

println!("{}", value.bright_green());

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example

println!("{}", value.bright_yellow());

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example

println!("{}", value.bright_blue());

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example

println!("{}", value.bright_magenta());

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example

println!("{}", value.bright_cyan());

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example

println!("{}", value.bright_white());

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();

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

§Example

println!("{}", value.on_primary());

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example

println!("{}", value.on_fixed(color));

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));

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example

println!("{}", value.on_black());

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example

println!("{}", value.on_red());

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example

println!("{}", value.on_green());

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example

println!("{}", value.on_yellow());

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example

println!("{}", value.on_blue());

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example

println!("{}", value.on_magenta());

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example

println!("{}", value.on_cyan());

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example

println!("{}", value.on_white());

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example

println!("{}", value.on_bright_black());

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example

println!("{}", value.on_bright_red());

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example

println!("{}", value.on_bright_green());

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example

println!("{}", value.on_bright_yellow());

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example

println!("{}", value.on_bright_blue());

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example

println!("{}", value.on_bright_magenta());

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example

println!("{}", value.on_bright_cyan());

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example

println!("{}", value.on_bright_white());

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();

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example

println!("{}", value.bold());

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example

println!("{}", value.dim());

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example

println!("{}", value.italic());

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example

println!("{}", value.underline());

fn blink(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Blink].

§Example

println!("{}", value.blink());

fn rapid_blink(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example

println!("{}", value.rapid_blink());

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example

println!("{}", value.invert());

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example

println!("{}", value.conceal());

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example

println!("{}", value.strike());

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();

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example

println!("{}", value.mask());

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example

println!("{}", value.wrap());

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example

println!("{}", value.linger());

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());

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example

println!("{}", value.resetting());

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example

println!("{}", value.bright());

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example

println!("{}", value.on_bright());

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);

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,