Struct Client

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

Client for FinSpace User Environment Management service

Client for invoking operations on FinSpace User Environment Management service. Each operation on FinSpace User Environment Management service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_finspace::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_finspace::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

§Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateEnvironment operation has a Client::create_environment, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_environment()
    .name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations§

Source§

impl Client

Source

pub fn create_environment(&self) -> CreateEnvironmentFluentBuilder

👎Deprecated: This method will be discontinued.

Constructs a fluent builder for the CreateEnvironment operation.

Source§

impl Client

Source

pub fn create_kx_changeset(&self) -> CreateKxChangesetFluentBuilder

Constructs a fluent builder for the CreateKxChangeset operation.

  • The fluent builder is configurable:
    • environment_id(impl Into<String>) / set_environment_id(Option<String>):
      required: true

      A unique identifier of the kdb environment.


    • database_name(impl Into<String>) / set_database_name(Option<String>):
      required: true

      The name of the kdb database.


    • change_requests(ChangeRequest) / set_change_requests(Option<Vec::<ChangeRequest>>):
      required: true

      A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. A changeType can have the following values:

      • PUT – Adds or updates files in a database.

      • DELETE – Deletes files in a database.

      All the change requests require a mandatory dbPath attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The s3Path attribute defines the s3 source file path and is required for a PUT change type. The s3path must end with a trailing / if it is a directory and must end without a trailing / if it is a file.

      Here are few examples of how you can use the change request object:

      1. This request adds a single sym file at database root location.

        { “changeType”: “PUT”, “s3Path”:“s3://bucket/db/sym”, “dbPath”:“/”}

      2. This request adds files in the given s3Path under the 2020.01.02 partition of the database.

        { “changeType”: “PUT”, “s3Path”:“s3://bucket/db/2020.01.02/”, “dbPath”:“/2020.01.02/”}

      3. This request adds files in the given s3Path under the taq table partition of the database.

        [ { “changeType”: “PUT”, “s3Path”:“s3://bucket/db/2020.01.02/taq/”, “dbPath”:“/2020.01.02/taq/”}]

      4. This request deletes the 2020.01.02 partition of the database.

        [{ “changeType”: “DELETE”, “dbPath”: “/2020.01.02/”} ]

      5. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it.

        [ {“changeType”: “DELETE”, “dbPath”:“/2020.01.02/”}, {“changeType”: “PUT”, “s3Path”:“s3://bucket/db/2020.01.02/taq/”, “dbPath”:“/2020.01.02/taq/”}]


    • client_token(impl Into<String>) / set_client_token(Option<String>):
      required: true

      A token that ensures idempotency. This token expires in 10 minutes.


  • On success, responds with CreateKxChangesetOutput with field(s):
  • On failure, responds with SdkError<CreateKxChangesetError>
Source§

impl Client

Source

pub fn create_kx_cluster(&self) -> CreateKxClusterFluentBuilder

Constructs a fluent builder for the CreateKxCluster operation.

Source§

impl Client

Source

pub fn create_kx_database(&self) -> CreateKxDatabaseFluentBuilder

Constructs a fluent builder for the CreateKxDatabase operation.

Source§

impl Client

Source

pub fn create_kx_dataview(&self) -> CreateKxDataviewFluentBuilder

Constructs a fluent builder for the CreateKxDataview operation.

Source§

impl Client

Source

pub fn create_kx_environment(&self) -> CreateKxEnvironmentFluentBuilder

Constructs a fluent builder for the CreateKxEnvironment operation.

Source§

impl Client

Source

pub fn create_kx_scaling_group(&self) -> CreateKxScalingGroupFluentBuilder

Constructs a fluent builder for the CreateKxScalingGroup operation.

Source§

impl Client

Source

pub fn create_kx_user(&self) -> CreateKxUserFluentBuilder

Constructs a fluent builder for the CreateKxUser operation.

Source§

impl Client

Source

pub fn create_kx_volume(&self) -> CreateKxVolumeFluentBuilder

Constructs a fluent builder for the CreateKxVolume operation.

Source§

impl Client

Source

pub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder

👎Deprecated: This method will be discontinued.

Constructs a fluent builder for the DeleteEnvironment operation.

Source§

impl Client

Source

pub fn delete_kx_cluster(&self) -> DeleteKxClusterFluentBuilder

Constructs a fluent builder for the DeleteKxCluster operation.

Source§

impl Client

Source

pub fn delete_kx_cluster_node(&self) -> DeleteKxClusterNodeFluentBuilder

Constructs a fluent builder for the DeleteKxClusterNode operation.

Source§

impl Client

Source

pub fn delete_kx_database(&self) -> DeleteKxDatabaseFluentBuilder

Constructs a fluent builder for the DeleteKxDatabase operation.

Source§

impl Client

Source

pub fn delete_kx_dataview(&self) -> DeleteKxDataviewFluentBuilder

Constructs a fluent builder for the DeleteKxDataview operation.

Source§

impl Client

Source

pub fn delete_kx_environment(&self) -> DeleteKxEnvironmentFluentBuilder

Constructs a fluent builder for the DeleteKxEnvironment operation.

Source§

impl Client

Source

pub fn delete_kx_scaling_group(&self) -> DeleteKxScalingGroupFluentBuilder

Constructs a fluent builder for the DeleteKxScalingGroup operation.

Source§

impl Client

Source

pub fn delete_kx_user(&self) -> DeleteKxUserFluentBuilder

Constructs a fluent builder for the DeleteKxUser operation.

Source§

impl Client

Source

pub fn delete_kx_volume(&self) -> DeleteKxVolumeFluentBuilder

Constructs a fluent builder for the DeleteKxVolume operation.

Source§

impl Client

Source

pub fn get_environment(&self) -> GetEnvironmentFluentBuilder

👎Deprecated: This method will be discontinued.

Constructs a fluent builder for the GetEnvironment operation.

Source§

impl Client

Source

pub fn get_kx_changeset(&self) -> GetKxChangesetFluentBuilder

Constructs a fluent builder for the GetKxChangeset operation.

Source§

impl Client

Source

pub fn get_kx_cluster(&self) -> GetKxClusterFluentBuilder

Constructs a fluent builder for the GetKxCluster operation.

  • The fluent builder is configurable:
  • On success, responds with GetKxClusterOutput with field(s):
    • status(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.

    • status_reason(Option<String>):

      The error message when a failed state occurs.

    • cluster_name(Option<String>):

      A unique name for the cluster.

    • cluster_type(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.

    • tickerplant_log_configuration(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.

    • volumes(Option<Vec::<Volume>>):

      A list of volumes attached to the cluster.

    • databases(Option<Vec::<KxDatabaseConfiguration>>):

      A list of databases mounted on the cluster.

    • cache_storage_configurations(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.

    • auto_scaling_configuration(Option<AutoScalingConfiguration>):

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

    • cluster_description(Option<String>):

      A description of the cluster.

    • capacity_configuration(Option<CapacityConfiguration>):

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

    • release_label(Option<String>):

      The version of FinSpace managed kdb to run.

    • vpc_configuration(Option<VpcConfiguration>):

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

    • initialization_script(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.

    • command_line_arguments(Option<Vec::<KxCommandLineArgument>>):

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

    • code(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.

    • execution_role(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.

    • last_modified_timestamp(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.

    • savedown_storage_configuration(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.

    • az_mode(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.

    • availability_zone_id(Option<String>):

      The availability zone identifiers for the requested regions.

    • created_timestamp(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.

    • scaling_group_configuration(Option<KxScalingGroupConfiguration>):

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

  • On failure, responds with SdkError<GetKxClusterError>
Source§

impl Client

Source

pub fn get_kx_connection_string(&self) -> GetKxConnectionStringFluentBuilder

Constructs a fluent builder for the GetKxConnectionString operation.

Source§

impl Client

Source

pub fn get_kx_database(&self) -> GetKxDatabaseFluentBuilder

Constructs a fluent builder for the GetKxDatabase operation.

Source§

impl Client

Source

pub fn get_kx_dataview(&self) -> GetKxDataviewFluentBuilder

Constructs a fluent builder for the GetKxDataview operation.

Source§

impl Client

Source

pub fn get_kx_environment(&self) -> GetKxEnvironmentFluentBuilder

Constructs a fluent builder for the GetKxEnvironment operation.

Source§

impl Client

Source

pub fn get_kx_scaling_group(&self) -> GetKxScalingGroupFluentBuilder

Constructs a fluent builder for the GetKxScalingGroup operation.

  • The fluent builder is configurable:
  • On success, responds with GetKxScalingGroupOutput with field(s):
    • scaling_group_name(Option<String>):

      A unique identifier for the kdb scaling group.

    • scaling_group_arn(Option<String>):

      The ARN identifier for the scaling group.

    • host_type(Option<String>):

      The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

      It can have one of the following values:

      • kx.sg.large – The host type with a configuration of 16 GiB memory and 2 vCPUs.

      • kx.sg.xlarge – The host type with a configuration of 32 GiB memory and 4 vCPUs.

      • kx.sg.2xlarge – The host type with a configuration of 64 GiB memory and 8 vCPUs.

      • kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.

      • kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.

      • kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.

      • kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.

      • kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.

      • kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.

    • clusters(Option<Vec::<String>>):

      The list of Managed kdb clusters that are currently active in the given scaling group.

    • availability_zone_id(Option<String>):

      The identifier of the availability zones.

    • status(Option<KxScalingGroupStatus>):

      The status of scaling group.

      • CREATING – The scaling group creation is in progress.

      • CREATE_FAILED – The scaling group creation has failed.

      • ACTIVE – The scaling group is active.

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

      • UPDATE_FAILED – The update action failed.

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

      • DELETE_FAILED – The system failed to delete the scaling group.

      • DELETED – The scaling group is successfully deleted.

    • status_reason(Option<String>):

      The error message when a failed state occurs.

    • last_modified_timestamp(Option<DateTime>):

      The last time that the scaling group was updated 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.

    • created_timestamp(Option<DateTime>):

      The timestamp at which the scaling group 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.

  • On failure, responds with SdkError<GetKxScalingGroupError>
Source§

impl Client

Source

pub fn get_kx_user(&self) -> GetKxUserFluentBuilder

Constructs a fluent builder for the GetKxUser operation.

Source§

impl Client

Source

pub fn get_kx_volume(&self) -> GetKxVolumeFluentBuilder

Constructs a fluent builder for the GetKxVolume operation.

Source§

impl Client

Source

pub fn list_environments(&self) -> ListEnvironmentsFluentBuilder

👎Deprecated: This method will be discontinued.

Constructs a fluent builder for the ListEnvironments operation.

Source§

impl Client

Source

pub fn list_kx_changesets(&self) -> ListKxChangesetsFluentBuilder

Constructs a fluent builder for the ListKxChangesets operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_kx_cluster_nodes(&self) -> ListKxClusterNodesFluentBuilder

Constructs a fluent builder for the ListKxClusterNodes operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_kx_clusters(&self) -> ListKxClustersFluentBuilder

Constructs a fluent builder for the ListKxClusters operation.

  • The fluent builder is configurable:
    • environment_id(impl Into<String>) / set_environment_id(Option<String>):
      required: true

      A unique identifier for the kdb environment.


    • cluster_type(KxClusterType) / set_cluster_type(Option<KxClusterType>):
      required: false

      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.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results to return in this request.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      A token that indicates where a results page should begin.


  • On success, responds with ListKxClustersOutput with field(s):
  • On failure, responds with SdkError<ListKxClustersError>
Source§

impl Client

Source

pub fn list_kx_databases(&self) -> ListKxDatabasesFluentBuilder

Constructs a fluent builder for the ListKxDatabases operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_kx_dataviews(&self) -> ListKxDataviewsFluentBuilder

Constructs a fluent builder for the ListKxDataviews operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_kx_environments(&self) -> ListKxEnvironmentsFluentBuilder

Constructs a fluent builder for the ListKxEnvironments operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_kx_scaling_groups(&self) -> ListKxScalingGroupsFluentBuilder

Constructs a fluent builder for the ListKxScalingGroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn list_kx_users(&self) -> ListKxUsersFluentBuilder

Constructs a fluent builder for the ListKxUsers operation.

Source§

impl Client

Source

pub fn list_kx_volumes(&self) -> ListKxVolumesFluentBuilder

Constructs a fluent builder for the ListKxVolumes operation.

Source§

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

Source§

impl Client

Source

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

Source§

impl Client

Source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

Source§

impl Client

Source

pub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder

👎Deprecated: This method will be discontinued.

Constructs a fluent builder for the UpdateEnvironment operation.

Source§

impl Client

Source

pub fn update_kx_cluster_code_configuration( &self, ) -> UpdateKxClusterCodeConfigurationFluentBuilder

Constructs a fluent builder for the UpdateKxClusterCodeConfiguration operation.

Source§

impl Client

Source

pub fn update_kx_cluster_databases( &self, ) -> UpdateKxClusterDatabasesFluentBuilder

Constructs a fluent builder for the UpdateKxClusterDatabases operation.

Source§

impl Client

Source

pub fn update_kx_database(&self) -> UpdateKxDatabaseFluentBuilder

Constructs a fluent builder for the UpdateKxDatabase operation.

Source§

impl Client

Source

pub fn update_kx_dataview(&self) -> UpdateKxDataviewFluentBuilder

Constructs a fluent builder for the UpdateKxDataview operation.

Source§

impl Client

Source

pub fn update_kx_environment(&self) -> UpdateKxEnvironmentFluentBuilder

Constructs a fluent builder for the UpdateKxEnvironment operation.

Source§

impl Client

Source

pub fn update_kx_environment_network( &self, ) -> UpdateKxEnvironmentNetworkFluentBuilder

Constructs a fluent builder for the UpdateKxEnvironmentNetwork operation.

Source§

impl Client

Source

pub fn update_kx_user(&self) -> UpdateKxUserFluentBuilder

Constructs a fluent builder for the UpdateKxUser operation.

Source§

impl Client

Source

pub fn update_kx_volume(&self) -> UpdateKxVolumeFluentBuilder

Constructs a fluent builder for the UpdateKxVolume operation.

Source§

impl Client

Source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

  • Retries or timeouts are enabled without a sleep_impl configured.
  • Identity caching is enabled without a sleep_impl and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

Source

pub fn config(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
  • This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

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 Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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,