Struct Client

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

Client for AWS Proton

Client for invoking operations on AWS Proton. Each operation on AWS Proton 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_proton::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_proton::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 AcceptEnvironmentAccountConnection operation has a Client::accept_environment_account_connection, 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.accept_environment_account_connection()
    .id("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.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations§

Source§

impl Client

Source

pub fn accept_environment_account_connection( &self, ) -> AcceptEnvironmentAccountConnectionFluentBuilder

Constructs a fluent builder for the AcceptEnvironmentAccountConnection operation.

Source§

impl Client

Source

pub fn cancel_component_deployment( &self, ) -> CancelComponentDeploymentFluentBuilder

Constructs a fluent builder for the CancelComponentDeployment operation.

Source§

impl Client

Source

pub fn cancel_environment_deployment( &self, ) -> CancelEnvironmentDeploymentFluentBuilder

Constructs a fluent builder for the CancelEnvironmentDeployment operation.

Source§

impl Client

Source

pub fn cancel_service_instance_deployment( &self, ) -> CancelServiceInstanceDeploymentFluentBuilder

Constructs a fluent builder for the CancelServiceInstanceDeployment operation.

Source§

impl Client

Source

pub fn cancel_service_pipeline_deployment( &self, ) -> CancelServicePipelineDeploymentFluentBuilder

Constructs a fluent builder for the CancelServicePipelineDeployment operation.

Source§

impl Client

Source

pub fn create_component(&self) -> CreateComponentFluentBuilder

Constructs a fluent builder for the CreateComponent operation.

Source§

impl Client

Source

pub fn create_environment(&self) -> CreateEnvironmentFluentBuilder

Constructs a fluent builder for the CreateEnvironment operation.

Source§

impl Client

Source

pub fn create_environment_account_connection( &self, ) -> CreateEnvironmentAccountConnectionFluentBuilder

Constructs a fluent builder for the CreateEnvironmentAccountConnection operation.

Source§

impl Client

Source

pub fn create_environment_template( &self, ) -> CreateEnvironmentTemplateFluentBuilder

Constructs a fluent builder for the CreateEnvironmentTemplate operation.

Source§

impl Client

Source

pub fn create_environment_template_version( &self, ) -> CreateEnvironmentTemplateVersionFluentBuilder

Constructs a fluent builder for the CreateEnvironmentTemplateVersion operation.

Source§

impl Client

Source

pub fn create_repository(&self) -> CreateRepositoryFluentBuilder

Constructs a fluent builder for the CreateRepository operation.

Source§

impl Client

Source

pub fn create_service(&self) -> CreateServiceFluentBuilder

Constructs a fluent builder for the CreateService operation.

Source§

impl Client

Source

pub fn create_service_instance(&self) -> CreateServiceInstanceFluentBuilder

Constructs a fluent builder for the CreateServiceInstance operation.

Source§

impl Client

Source

pub fn create_service_sync_config(&self) -> CreateServiceSyncConfigFluentBuilder

Constructs a fluent builder for the CreateServiceSyncConfig operation.

Source§

impl Client

Source

pub fn create_service_template(&self) -> CreateServiceTemplateFluentBuilder

Constructs a fluent builder for the CreateServiceTemplate operation.

Source§

impl Client

Source

pub fn create_service_template_version( &self, ) -> CreateServiceTemplateVersionFluentBuilder

Constructs a fluent builder for the CreateServiceTemplateVersion operation.

Source§

impl Client

Source

pub fn create_template_sync_config( &self, ) -> CreateTemplateSyncConfigFluentBuilder

Constructs a fluent builder for the CreateTemplateSyncConfig operation.

Source§

impl Client

Source

pub fn delete_component(&self) -> DeleteComponentFluentBuilder

Constructs a fluent builder for the DeleteComponent operation.

Source§

impl Client

Source

pub fn delete_deployment(&self) -> DeleteDeploymentFluentBuilder

Constructs a fluent builder for the DeleteDeployment operation.

Source§

impl Client

Source

pub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder

Constructs a fluent builder for the DeleteEnvironment operation.

Source§

impl Client

Source

pub fn delete_environment_account_connection( &self, ) -> DeleteEnvironmentAccountConnectionFluentBuilder

Constructs a fluent builder for the DeleteEnvironmentAccountConnection operation.

Source§

impl Client

Source

pub fn delete_environment_template( &self, ) -> DeleteEnvironmentTemplateFluentBuilder

Constructs a fluent builder for the DeleteEnvironmentTemplate operation.

Source§

impl Client

Source

pub fn delete_environment_template_version( &self, ) -> DeleteEnvironmentTemplateVersionFluentBuilder

Constructs a fluent builder for the DeleteEnvironmentTemplateVersion operation.

Source§

impl Client

Source

pub fn delete_repository(&self) -> DeleteRepositoryFluentBuilder

Constructs a fluent builder for the DeleteRepository operation.

Source§

impl Client

Source

pub fn delete_service(&self) -> DeleteServiceFluentBuilder

Constructs a fluent builder for the DeleteService operation.

Source§

impl Client

Source

pub fn delete_service_sync_config(&self) -> DeleteServiceSyncConfigFluentBuilder

Constructs a fluent builder for the DeleteServiceSyncConfig operation.

Source§

impl Client

Source

pub fn delete_service_template(&self) -> DeleteServiceTemplateFluentBuilder

Constructs a fluent builder for the DeleteServiceTemplate operation.

Source§

impl Client

Source

pub fn delete_service_template_version( &self, ) -> DeleteServiceTemplateVersionFluentBuilder

Constructs a fluent builder for the DeleteServiceTemplateVersion operation.

Source§

impl Client

Source

pub fn delete_template_sync_config( &self, ) -> DeleteTemplateSyncConfigFluentBuilder

Constructs a fluent builder for the DeleteTemplateSyncConfig operation.

Source§

impl Client

Source

pub fn get_account_settings(&self) -> GetAccountSettingsFluentBuilder

Constructs a fluent builder for the GetAccountSettings operation.

Source§

impl Client

Source

pub fn get_component(&self) -> GetComponentFluentBuilder

Constructs a fluent builder for the GetComponent operation.

Source§

impl Client

Source

pub fn get_deployment(&self) -> GetDeploymentFluentBuilder

Constructs a fluent builder for the GetDeployment operation.

Source§

impl Client

Source

pub fn get_environment(&self) -> GetEnvironmentFluentBuilder

Constructs a fluent builder for the GetEnvironment operation.

Source§

impl Client

Source

pub fn get_environment_account_connection( &self, ) -> GetEnvironmentAccountConnectionFluentBuilder

Constructs a fluent builder for the GetEnvironmentAccountConnection operation.

Source§

impl Client

Source

pub fn get_environment_template(&self) -> GetEnvironmentTemplateFluentBuilder

Constructs a fluent builder for the GetEnvironmentTemplate operation.

Source§

impl Client

Source

pub fn get_environment_template_version( &self, ) -> GetEnvironmentTemplateVersionFluentBuilder

Constructs a fluent builder for the GetEnvironmentTemplateVersion operation.

Source§

impl Client

Source

pub fn get_repository(&self) -> GetRepositoryFluentBuilder

Constructs a fluent builder for the GetRepository operation.

Source§

impl Client

Source

pub fn get_repository_sync_status(&self) -> GetRepositorySyncStatusFluentBuilder

Constructs a fluent builder for the GetRepositorySyncStatus operation.

Source§

impl Client

Source

pub fn get_resources_summary(&self) -> GetResourcesSummaryFluentBuilder

Constructs a fluent builder for the GetResourcesSummary operation.

Source§

impl Client

Source

pub fn get_service(&self) -> GetServiceFluentBuilder

Constructs a fluent builder for the GetService operation.

Source§

impl Client

Source

pub fn get_service_instance(&self) -> GetServiceInstanceFluentBuilder

Constructs a fluent builder for the GetServiceInstance operation.

Source§

impl Client

Source

pub fn get_service_instance_sync_status( &self, ) -> GetServiceInstanceSyncStatusFluentBuilder

Constructs a fluent builder for the GetServiceInstanceSyncStatus operation.

Source§

impl Client

Source

pub fn get_service_sync_blocker_summary( &self, ) -> GetServiceSyncBlockerSummaryFluentBuilder

Constructs a fluent builder for the GetServiceSyncBlockerSummary operation.

Source§

impl Client

Source

pub fn get_service_sync_config(&self) -> GetServiceSyncConfigFluentBuilder

Constructs a fluent builder for the GetServiceSyncConfig operation.

Source§

impl Client

Source

pub fn get_service_template(&self) -> GetServiceTemplateFluentBuilder

Constructs a fluent builder for the GetServiceTemplate operation.

Source§

impl Client

Source

pub fn get_service_template_version( &self, ) -> GetServiceTemplateVersionFluentBuilder

Constructs a fluent builder for the GetServiceTemplateVersion operation.

Source§

impl Client

Source

pub fn get_template_sync_config(&self) -> GetTemplateSyncConfigFluentBuilder

Constructs a fluent builder for the GetTemplateSyncConfig operation.

Source§

impl Client

Source

pub fn get_template_sync_status(&self) -> GetTemplateSyncStatusFluentBuilder

Constructs a fluent builder for the GetTemplateSyncStatus operation.

Source§

impl Client

Source

pub fn list_component_outputs(&self) -> ListComponentOutputsFluentBuilder

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

Source§

impl Client

Source

pub fn list_component_provisioned_resources( &self, ) -> ListComponentProvisionedResourcesFluentBuilder

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

Source§

impl Client

Source

pub fn list_components(&self) -> ListComponentsFluentBuilder

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

Source§

impl Client

Source

pub fn list_deployments(&self) -> ListDeploymentsFluentBuilder

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

Source§

impl Client

Source

pub fn list_environment_account_connections( &self, ) -> ListEnvironmentAccountConnectionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_environment_outputs(&self) -> ListEnvironmentOutputsFluentBuilder

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

Source§

impl Client

Source

pub fn list_environment_provisioned_resources( &self, ) -> ListEnvironmentProvisionedResourcesFluentBuilder

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

Source§

impl Client

Source

pub fn list_environment_template_versions( &self, ) -> ListEnvironmentTemplateVersionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_environment_templates( &self, ) -> ListEnvironmentTemplatesFluentBuilder

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

Source§

impl Client

Source

pub fn list_environments(&self) -> ListEnvironmentsFluentBuilder

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

Source§

impl Client

Source

pub fn list_repositories(&self) -> ListRepositoriesFluentBuilder

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

Source§

impl Client

Source

pub fn list_repository_sync_definitions( &self, ) -> ListRepositorySyncDefinitionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_service_instance_outputs( &self, ) -> ListServiceInstanceOutputsFluentBuilder

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

Source§

impl Client

Source

pub fn list_service_instance_provisioned_resources( &self, ) -> ListServiceInstanceProvisionedResourcesFluentBuilder

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

Source§

impl Client

Source

pub fn list_service_instances(&self) -> ListServiceInstancesFluentBuilder

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

Source§

impl Client

Source

pub fn list_service_pipeline_outputs( &self, ) -> ListServicePipelineOutputsFluentBuilder

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

Source§

impl Client

Source

pub fn list_service_pipeline_provisioned_resources( &self, ) -> ListServicePipelineProvisionedResourcesFluentBuilder

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

Source§

impl Client

Source

pub fn list_service_template_versions( &self, ) -> ListServiceTemplateVersionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_service_templates(&self) -> ListServiceTemplatesFluentBuilder

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

Source§

impl Client

Source

pub fn list_services(&self) -> ListServicesFluentBuilder

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

Source§

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

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

Source§

impl Client

Source

pub fn notify_resource_deployment_status_change( &self, ) -> NotifyResourceDeploymentStatusChangeFluentBuilder

Constructs a fluent builder for the NotifyResourceDeploymentStatusChange operation.

Source§

impl Client

Source

pub fn reject_environment_account_connection( &self, ) -> RejectEnvironmentAccountConnectionFluentBuilder

Constructs a fluent builder for the RejectEnvironmentAccountConnection 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_account_settings(&self) -> UpdateAccountSettingsFluentBuilder

Constructs a fluent builder for the UpdateAccountSettings operation.

Source§

impl Client

Source

pub fn update_component(&self) -> UpdateComponentFluentBuilder

Constructs a fluent builder for the UpdateComponent operation.

Source§

impl Client

Source

pub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder

Constructs a fluent builder for the UpdateEnvironment operation.

Source§

impl Client

Source

pub fn update_environment_account_connection( &self, ) -> UpdateEnvironmentAccountConnectionFluentBuilder

Constructs a fluent builder for the UpdateEnvironmentAccountConnection operation.

Source§

impl Client

Source

pub fn update_environment_template( &self, ) -> UpdateEnvironmentTemplateFluentBuilder

Constructs a fluent builder for the UpdateEnvironmentTemplate operation.

Source§

impl Client

Source

pub fn update_environment_template_version( &self, ) -> UpdateEnvironmentTemplateVersionFluentBuilder

Constructs a fluent builder for the UpdateEnvironmentTemplateVersion operation.

Source§

impl Client

Source

pub fn update_service(&self) -> UpdateServiceFluentBuilder

Constructs a fluent builder for the UpdateService operation.

Source§

impl Client

Source

pub fn update_service_instance(&self) -> UpdateServiceInstanceFluentBuilder

Constructs a fluent builder for the UpdateServiceInstance operation.

Source§

impl Client

Source

pub fn update_service_pipeline(&self) -> UpdateServicePipelineFluentBuilder

Constructs a fluent builder for the UpdateServicePipeline operation.

Source§

impl Client

Source

pub fn update_service_sync_blocker( &self, ) -> UpdateServiceSyncBlockerFluentBuilder

Constructs a fluent builder for the UpdateServiceSyncBlocker operation.

Source§

impl Client

Source

pub fn update_service_sync_config(&self) -> UpdateServiceSyncConfigFluentBuilder

Constructs a fluent builder for the UpdateServiceSyncConfig operation.

Source§

impl Client

Source

pub fn update_service_template(&self) -> UpdateServiceTemplateFluentBuilder

Constructs a fluent builder for the UpdateServiceTemplate operation.

Source§

impl Client

Source

pub fn update_service_template_version( &self, ) -> UpdateServiceTemplateVersionFluentBuilder

Constructs a fluent builder for the UpdateServiceTemplateVersion operation.

Source§

impl Client

Source

pub fn update_template_sync_config( &self, ) -> UpdateTemplateSyncConfigFluentBuilder

Constructs a fluent builder for the UpdateTemplateSyncConfig 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
Source§

impl Waiters for Client

Source§

fn wait_until_component_deployed(&self) -> ComponentDeployedFluentBuilder

Wait until a Component is deployed. Use this after invoking CreateComponent or UpdateComponent
Source§

fn wait_until_component_deleted(&self) -> ComponentDeletedFluentBuilder

Wait until a Component is deleted. Use this after invoking DeleteComponent
Source§

fn wait_until_environment_deployed(&self) -> EnvironmentDeployedFluentBuilder

Wait until an Environment is deployed. Use this after invoking CreateEnvironment or UpdateEnvironment
Source§

fn wait_until_environment_template_version_registered( &self, ) -> EnvironmentTemplateVersionRegisteredFluentBuilder

Wait until an EnvironmentTemplateVersion is registered. Use this after invoking CreateEnvironmentTemplateVersion
Source§

fn wait_until_service_created(&self) -> ServiceCreatedFluentBuilder

Wait until an Service has deployed its instances and possibly pipeline. Use this after invoking CreateService
Source§

fn wait_until_service_updated(&self) -> ServiceUpdatedFluentBuilder

Wait until a Service, its instances, and possibly pipeline have been deployed after UpdateService is invoked
Source§

fn wait_until_service_deleted(&self) -> ServiceDeletedFluentBuilder

Wait until a Service, its instances, and possibly pipeline have been deleted after DeleteService is invoked
Source§

fn wait_until_service_pipeline_deployed( &self, ) -> ServicePipelineDeployedFluentBuilder

Wait until an ServicePipeline is deployed. Use this after invoking CreateService or UpdateServicePipeline
Source§

fn wait_until_service_instance_deployed( &self, ) -> ServiceInstanceDeployedFluentBuilder

Wait until a ServiceInstance is deployed. Use this after invoking CreateService or UpdateServiceInstance
Source§

fn wait_until_service_template_version_registered( &self, ) -> ServiceTemplateVersionRegisteredFluentBuilder

Wait until a ServiceTemplateVersion is registered. Use this after invoking CreateServiceTemplateVersion

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,