aws_sdk_odb::types::builders

Struct CloudAutonomousVmClusterSummaryBuilder

Source 
#[non_exhaustive]
pub struct CloudAutonomousVmClusterSummaryBuilder { /* private fields */ }
Expand description

A builder for CloudAutonomousVmClusterSummary.

Implementations§

Source§

impl CloudAutonomousVmClusterSummaryBuilder

Source

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

The unique identifier of the Autonomous VM cluster.

This field is required.
Source

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

The unique identifier of the Autonomous VM cluster.

Source

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

The unique identifier of the Autonomous VM cluster.

Source

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

The Amazon Resource Name (ARN) for the Autonomous VM cluster.

Source

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

The Amazon Resource Name (ARN) for the Autonomous VM cluster.

Source

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

The Amazon Resource Name (ARN) for the Autonomous VM cluster.

Source

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

The unique identifier of the ODB network associated with this Autonomous VM cluster.

Source

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

The unique identifier of the ODB network associated with this Autonomous VM cluster.

Source

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

The unique identifier of the ODB network associated with this Autonomous VM cluster.

Source

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

The name of the OCI resource anchor associated with this Autonomous VM cluster.

Source

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

The name of the OCI resource anchor associated with this Autonomous VM cluster.

Source

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

The name of the OCI resource anchor associated with this Autonomous VM cluster.

Source

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

The progress of the current operation on the Autonomous VM cluster, as a percentage.

Source

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

The progress of the current operation on the Autonomous VM cluster, as a percentage.

Source

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

The progress of the current operation on the Autonomous VM cluster, as a percentage.

Source

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

The user-friendly name for the Autonomous VM cluster.

Source

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

The user-friendly name for the Autonomous VM cluster.

Source

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

The user-friendly name for the Autonomous VM cluster.

Source

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

The current status of the Autonomous VM cluster.

Source

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

The current status of the Autonomous VM cluster.

Source

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

The current status of the Autonomous VM cluster.

Source

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

Additional information about the current status of the Autonomous VM cluster, if applicable.

Source

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

Additional information about the current status of the Autonomous VM cluster, if applicable.

Source

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

Additional information about the current status of the Autonomous VM cluster, if applicable.

Source

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

The unique identifier of the Exadata infrastructure containing this Autonomous VM cluster.

Source

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

The unique identifier of the Exadata infrastructure containing this Autonomous VM cluster.

Source

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

The unique identifier of the Exadata infrastructure containing this Autonomous VM cluster.

Source

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

The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.

Source

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

The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.

Source

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

The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.

Source

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

The total data storage allocated for Autonomous Databases in the Autonomous VM cluster, in TB.

Source

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

The total data storage allocated for Autonomous Databases in the Autonomous VM cluster, in TB.

Source

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

The total data storage allocated for Autonomous Databases in the Autonomous VM cluster, in TB.

Source

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

The available data storage for Autonomous Databases in the Autonomous VM cluster, in TB.

Source

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

The available data storage for Autonomous Databases in the Autonomous VM cluster, in TB.

Source

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

The available data storage for Autonomous Databases in the Autonomous VM cluster, in TB.

Source

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

The number of Autonomous Container Databases that you can create with the currently available storage.

Source

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

The number of Autonomous Container Databases that you can create with the currently available storage.

Source

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

The number of Autonomous Container Databases that you can create with the currently available storage.

Source

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

The number of CPU cores available for allocation to Autonomous Databases.

Source

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

The number of CPU cores available for allocation to Autonomous Databases.

Source

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

The number of CPU cores available for allocation to Autonomous Databases.

Source

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

The compute model of the Autonomous VM cluster: ECPU or OCPU.

Source

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

The compute model of the Autonomous VM cluster: ECPU or OCPU.

Source

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

The compute model of the Autonomous VM cluster: ECPU or OCPU.

Source

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

The total number of CPU cores in the Autonomous VM cluster.

Source

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

The total number of CPU cores in the Autonomous VM cluster.

Source

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

The total number of CPU cores in the Autonomous VM cluster.

Source

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

The number of CPU cores per node in the Autonomous VM cluster.

Source

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

The number of CPU cores per node in the Autonomous VM cluster.

Source

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

The number of CPU cores per node in the Autonomous VM cluster.

Source

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

The percentage of total CPU cores currently in use in the Autonomous VM cluster.

Source

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

The percentage of total CPU cores currently in use in the Autonomous VM cluster.

Source

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

The percentage of total CPU cores currently in use in the Autonomous VM cluster.

Source

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

The total data storage allocated to the Autonomous VM cluster, in GB.

Source

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

The total data storage allocated to the Autonomous VM cluster, in GB.

Source

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

The total data storage allocated to the Autonomous VM cluster, in GB.

Source

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

The total data storage allocated to the Autonomous VM cluster, in TB.

Source

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

The total data storage allocated to the Autonomous VM cluster, in TB.

Source

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

The total data storage allocated to the Autonomous VM cluster, in TB.

Source

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

The local node storage allocated to the Autonomous VM cluster, in GB.

Source

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

The local node storage allocated to the Autonomous VM cluster, in GB.

Source

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

The local node storage allocated to the Autonomous VM cluster, in GB.

Source

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

Appends an item to db_servers.

To override the contents of this collection use set_db_servers.

The list of database servers associated with the Autonomous VM cluster.

Source

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

The list of database servers associated with the Autonomous VM cluster.

Source

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

The list of database servers associated with the Autonomous VM cluster.

Source

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

The user-provided description of the Autonomous VM cluster.

Source

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

The user-provided description of the Autonomous VM cluster.

Source

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

The user-provided description of the Autonomous VM cluster.

Source

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

The domain name for the Autonomous VM cluster.

Source

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

The domain name for the Autonomous VM cluster.

Source

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

The domain name for the Autonomous VM cluster.

Source

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

The lowest value to which Exadata storage can be scaled down, in TB.

Source

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

The lowest value to which Exadata storage can be scaled down, in TB.

Source

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

The lowest value to which Exadata storage can be scaled down, in TB.

Source

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

The host name for the Autonomous VM cluster.

Source

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

The host name for the Autonomous VM cluster.

Source

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

The host name for the Autonomous VM cluster.

Source

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

The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.

Source

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

The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.

Source

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

The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.

Source

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

The URL for accessing the OCI console page for this Autonomous VM cluster.

Source

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

The URL for accessing the OCI console page for this Autonomous VM cluster.

Source

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

The URL for accessing the OCI console page for this Autonomous VM cluster.

Source

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

Indicates if mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.

Source

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

Indicates if mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.

Source

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

Indicates if mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.

Source

pub fn license_model(self, input: LicenseModel) -> Self

The Oracle license model that applies to the Autonomous VM cluster.

Source

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

The Oracle license model that applies to the Autonomous VM cluster.

Source

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

The Oracle license model that applies to the Autonomous VM cluster.

Source

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.

Source

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.

Source

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.

Source

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

The lowest value to which you can scale down the maximum number of Autonomous CDBs.

Source

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

The lowest value to which you can scale down the maximum number of Autonomous CDBs.

Source

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

The lowest value to which you can scale down the maximum number of Autonomous CDBs.

Source

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

The amount of memory allocated per Oracle Compute Unit (OCU), in GB.

Source

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

The amount of memory allocated per Oracle Compute Unit (OCU), in GB.

Source

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

The amount of memory allocated per Oracle Compute Unit (OCU), in GB.

Source

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

The total amount of memory allocated to the Autonomous VM cluster, in GB.

Source

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

The total amount of memory allocated to the Autonomous VM cluster, in GB.

Source

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

The total amount of memory allocated to the Autonomous VM cluster, in GB.

Source

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

The number of database server nodes in the Autonomous VM cluster.

Source

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

The number of database server nodes in the Autonomous VM cluster.

Source

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

The number of database server nodes in the Autonomous VM cluster.

Source

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

The number of Autonomous CDBs that can't be provisioned because of resource constraints.

Source

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

The number of Autonomous CDBs that can't be provisioned because of resource constraints.

Source

pub fn get_non_provisionable_autonomous_container_databases( &self, ) -> &Option<i32>

The number of Autonomous CDBs that can't be provisioned because of resource constraints.

Source

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

The number of Autonomous CDBs that you can provision in the Autonomous VM cluster.

Source

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

The number of Autonomous CDBs that you can provision in the Autonomous VM cluster.

Source

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

The number of Autonomous CDBs that you can provision in the Autonomous VM cluster.

Source

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

The number of Autonomous Container Databases currently provisioned in the Autonomous VM cluster.

Source

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

The number of Autonomous Container Databases currently provisioned in the Autonomous VM cluster.

Source

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

The number of Autonomous Container Databases currently provisioned in the Autonomous VM cluster.

Source

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

The number of CPUs currently provisioned in the Autonomous VM cluster.

Source

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

The number of CPUs currently provisioned in the Autonomous VM cluster.

Source

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

The number of CPUs currently provisioned in the Autonomous VM cluster.

Source

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

The number of CPUs that can be reclaimed from terminated or scaled-down Autonomous Databases.

Source

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

The number of CPUs that can be reclaimed from terminated or scaled-down Autonomous Databases.

Source

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

The number of CPUs that can be reclaimed from terminated or scaled-down Autonomous Databases.

Source

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

The number of CPUs reserved for system operations and redundancy.

Source

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

The number of CPUs reserved for system operations and redundancy.

Source

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

The number of CPUs reserved for system operations and redundancy.

Source

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

The SCAN listener port for non-TLS (TCP) protocol.

Source

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

The SCAN listener port for non-TLS (TCP) protocol.

Source

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

The SCAN listener port for non-TLS (TCP) protocol.

Source

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

The SCAN listener port for TLS (TCP) protocol.

Source

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

The SCAN listener port for TLS (TCP) protocol.

Source

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

The SCAN listener port for TLS (TCP) protocol.

Source

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

The shape of the Exadata infrastructure for the Autonomous VM cluster.

Source

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

The shape of the Exadata infrastructure for the Autonomous VM cluster.

Source

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

The shape of the Exadata infrastructure for the Autonomous VM cluster.

Source

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

The date and time when the Autonomous VM cluster was created.

Source

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

The date and time when the Autonomous VM cluster was created.

Source

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

The date and time when the Autonomous VM cluster was created.

Source

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

The expiration date and time of the database SSL certificate.

Source

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

The expiration date and time of the database SSL certificate.

Source

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

The expiration date and time of the database SSL certificate.

Source

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

The expiration date and time of the Oracle REST Data Services (ORDS) certificate.

Source

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

The expiration date and time of the Oracle REST Data Services (ORDS) certificate.

Source

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

The expiration date and time of the Oracle REST Data Services (ORDS) certificate.

Source

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

The time zone of the Autonomous VM cluster.

Source

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

The time zone of the Autonomous VM cluster.

Source

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

The time zone of the Autonomous VM cluster.

Source

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

The total number of Autonomous Container Databases that can be created in the Autonomous VM cluster.

Source

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

The total number of Autonomous Container Databases that can be created in the Autonomous VM cluster.

Source

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

The total number of Autonomous Container Databases that can be created in the Autonomous VM cluster.

Source

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

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

Trait Implementations§

Source§

impl Clone for CloudAutonomousVmClusterSummaryBuilder

Source§

fn clone(&self) -> CloudAutonomousVmClusterSummaryBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CloudAutonomousVmClusterSummaryBuilder

Source§

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

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

impl Default for CloudAutonomousVmClusterSummaryBuilder

Source§

fn default() -> CloudAutonomousVmClusterSummaryBuilder

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

impl PartialEq for CloudAutonomousVmClusterSummaryBuilder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for CloudAutonomousVmClusterSummaryBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

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

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

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

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

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

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

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

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

§Example
println!("{}", value.rgb(r, g, b));
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

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

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

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

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

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

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

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

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

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

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

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

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

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

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

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

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

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

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

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

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

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

§Example
println!("{}", value.clear());
Source§

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

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

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

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

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

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

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

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

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

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

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

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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