aws_sdk_finspace::operation::create_kx_cluster::builders

Struct CreateKxClusterOutputBuilder

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

A builder for CreateKxClusterOutput.

Implementations§

Source§

impl CreateKxClusterOutputBuilder

Source

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

A unique identifier for the kdb environment.

Source

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

A unique identifier for the kdb environment.

Source

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

A unique identifier for the kdb environment.

Source

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

The status of cluster creation.

  • PENDING – The cluster is pending creation.

  • CREATING – The cluster creation process is in progress.

  • CREATE_FAILED – The cluster creation process has failed.

  • RUNNING – The cluster creation process is running.

  • UPDATING – The cluster is in the process of being updated.

  • DELETING – The cluster is in the process of being deleted.

  • DELETED – The cluster has been deleted.

  • DELETE_FAILED – The cluster failed to delete.

Source

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

The status of cluster creation.

  • PENDING – The cluster is pending creation.

  • CREATING – The cluster creation process is in progress.

  • CREATE_FAILED – The cluster creation process has failed.

  • RUNNING – The cluster creation process is running.

  • UPDATING – The cluster is in the process of being updated.

  • DELETING – The cluster is in the process of being deleted.

  • DELETED – The cluster has been deleted.

  • DELETE_FAILED – The cluster failed to delete.

Source

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

The status of cluster creation.

  • PENDING – The cluster is pending creation.

  • CREATING – The cluster creation process is in progress.

  • CREATE_FAILED – The cluster creation process has failed.

  • RUNNING – The cluster creation process is running.

  • UPDATING – The cluster is in the process of being updated.

  • DELETING – The cluster is in the process of being deleted.

  • DELETED – The cluster has been deleted.

  • DELETE_FAILED – The cluster failed to delete.

Source

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

The error message when a failed state occurs.

Source

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

The error message when a failed state occurs.

Source

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

The error message when a failed state occurs.

Source

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

A unique name for the cluster.

Source

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

A unique name for the cluster.

Source

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

A unique name for the cluster.

Source

pub fn cluster_type(self, input: KxClusterType) -> Self

Specifies the type of KDB database that is being created. The following types are available:

  • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

  • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

  • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

  • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

  • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

Source

pub fn set_cluster_type(self, input: Option<KxClusterType>) -> Self

Specifies the type of KDB database that is being created. The following types are available:

  • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

  • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

  • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

  • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

  • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

Source

pub fn get_cluster_type(&self) -> &Option<KxClusterType>

Specifies the type of KDB database that is being created. The following types are available:

  • HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

  • RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

  • GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

  • GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.

  • Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

Source

pub fn tickerplant_log_configuration( self, input: TickerplantLogConfiguration, ) -> Self

A configuration to store the Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.

Source

pub fn set_tickerplant_log_configuration( self, input: Option<TickerplantLogConfiguration>, ) -> Self

A configuration to store the Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.

Source

pub fn get_tickerplant_log_configuration( &self, ) -> &Option<TickerplantLogConfiguration>

A configuration to store the Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path.

Source

pub fn volumes(self, input: Volume) -> Self

Appends an item to volumes.

To override the contents of this collection use set_volumes.

A list of volumes mounted on the cluster.

Source

pub fn set_volumes(self, input: Option<Vec<Volume>>) -> Self

A list of volumes mounted on the cluster.

Source

pub fn get_volumes(&self) -> &Option<Vec<Volume>>

A list of volumes mounted on the cluster.

Source

pub fn databases(self, input: KxDatabaseConfiguration) -> Self

Appends an item to databases.

To override the contents of this collection use set_databases.

A list of databases that will be available for querying.

Source

pub fn set_databases(self, input: Option<Vec<KxDatabaseConfiguration>>) -> Self

A list of databases that will be available for querying.

Source

pub fn get_databases(&self) -> &Option<Vec<KxDatabaseConfiguration>>

A list of databases that will be available for querying.

Source

pub fn cache_storage_configurations( self, input: KxCacheStorageConfiguration, ) -> Self

Appends an item to cache_storage_configurations.

To override the contents of this collection use set_cache_storage_configurations.

The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

Source

pub fn set_cache_storage_configurations( self, input: Option<Vec<KxCacheStorageConfiguration>>, ) -> Self

The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

Source

pub fn get_cache_storage_configurations( &self, ) -> &Option<Vec<KxCacheStorageConfiguration>>

The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

Source

pub fn auto_scaling_configuration(self, input: AutoScalingConfiguration) -> Self

The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

Source

pub fn set_auto_scaling_configuration( self, input: Option<AutoScalingConfiguration>, ) -> Self

The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

Source

pub fn get_auto_scaling_configuration( &self, ) -> &Option<AutoScalingConfiguration>

The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

Source

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

A description of the cluster.

Source

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

A description of the cluster.

Source

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

A description of the cluster.

Source

pub fn capacity_configuration(self, input: CapacityConfiguration) -> Self

A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

Source

pub fn set_capacity_configuration( self, input: Option<CapacityConfiguration>, ) -> Self

A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

Source

pub fn get_capacity_configuration(&self) -> &Option<CapacityConfiguration>

A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

Source

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

A version of the FinSpace managed kdb to run.

Source

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

A version of the FinSpace managed kdb to run.

Source

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

A version of the FinSpace managed kdb to run.

Source

pub fn vpc_configuration(self, input: VpcConfiguration) -> Self

Configuration details about the network where the Privatelink endpoint of the cluster resides.

Source

pub fn set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self

Configuration details about the network where the Privatelink endpoint of the cluster resides.

Source

pub fn get_vpc_configuration(&self) -> &Option<VpcConfiguration>

Configuration details about the network where the Privatelink endpoint of the cluster resides.

Source

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

Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

Source

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

Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

Source

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

Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.

Source

pub fn command_line_arguments(self, input: KxCommandLineArgument) -> Self

Appends an item to command_line_arguments.

To override the contents of this collection use set_command_line_arguments.

Defines the key-value pairs to make them available inside the cluster.

Source

pub fn set_command_line_arguments( self, input: Option<Vec<KxCommandLineArgument>>, ) -> Self

Defines the key-value pairs to make them available inside the cluster.

Source

pub fn get_command_line_arguments(&self) -> &Option<Vec<KxCommandLineArgument>>

Defines the key-value pairs to make them available inside the cluster.

Source

pub fn code(self, input: CodeConfiguration) -> Self

The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

Source

pub fn set_code(self, input: Option<CodeConfiguration>) -> Self

The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

Source

pub fn get_code(&self) -> &Option<CodeConfiguration>

The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

Source

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

An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

Source

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

An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

Source

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

An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

Source

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

The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Source

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

The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Source

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

The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Source

pub fn savedown_storage_configuration( self, input: KxSavedownStorageConfiguration, ) -> Self

The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

Source

pub fn set_savedown_storage_configuration( self, input: Option<KxSavedownStorageConfiguration>, ) -> Self

The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

Source

pub fn get_savedown_storage_configuration( &self, ) -> &Option<KxSavedownStorageConfiguration>

The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

Source

pub fn az_mode(self, input: KxAzMode) -> Self

The number of availability zones you want to assign per cluster. This can be one of the following

  • SINGLE – Assigns one availability zone per cluster.

  • MULTI – Assigns all the availability zones per cluster.

Source

pub fn set_az_mode(self, input: Option<KxAzMode>) -> Self

The number of availability zones you want to assign per cluster. This can be one of the following

  • SINGLE – Assigns one availability zone per cluster.

  • MULTI – Assigns all the availability zones per cluster.

Source

pub fn get_az_mode(&self) -> &Option<KxAzMode>

The number of availability zones you want to assign per cluster. This can be one of the following

  • SINGLE – Assigns one availability zone per cluster.

  • MULTI – Assigns all the availability zones per cluster.

Source

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

The availability zone identifiers for the requested regions.

Source

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

The availability zone identifiers for the requested regions.

Source

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

The availability zone identifiers for the requested regions.

Source

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

The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Source

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

The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Source

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

The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Source

pub fn scaling_group_configuration( self, input: KxScalingGroupConfiguration, ) -> Self

The structure that stores the configuration details of a scaling group.

Source

pub fn set_scaling_group_configuration( self, input: Option<KxScalingGroupConfiguration>, ) -> Self

The structure that stores the configuration details of a scaling group.

Source

pub fn get_scaling_group_configuration( &self, ) -> &Option<KxScalingGroupConfiguration>

The structure that stores the configuration details of a scaling group.

Source

pub fn build(self) -> CreateKxClusterOutput

Consumes the builder and constructs a CreateKxClusterOutput.

Trait Implementations§

Source§

impl Clone for CreateKxClusterOutputBuilder

Source§

fn clone(&self) -> CreateKxClusterOutputBuilder

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 CreateKxClusterOutputBuilder

Source§

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

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

impl Default for CreateKxClusterOutputBuilder

Source§

fn default() -> CreateKxClusterOutputBuilder

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

impl PartialEq for CreateKxClusterOutputBuilder

Source§

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

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,