Client

Struct Client 

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

Client for AWS Clean Rooms Service

Client for invoking operations on AWS Clean Rooms Service. Each operation on AWS Clean Rooms 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_cleanrooms::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_cleanrooms::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 BatchGetCollaborationAnalysisTemplate operation has a Client::batch_get_collaboration_analysis_template, 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.batch_get_collaboration_analysis_template()
    .collaboration_identifier("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 batch_get_collaboration_analysis_template( &self, ) -> BatchGetCollaborationAnalysisTemplateFluentBuilder

Constructs a fluent builder for the BatchGetCollaborationAnalysisTemplate operation.

Source§

impl Client

Source

pub fn batch_get_schema(&self) -> BatchGetSchemaFluentBuilder

Constructs a fluent builder for the BatchGetSchema operation.

Source§

impl Client

Source

pub fn batch_get_schema_analysis_rule( &self, ) -> BatchGetSchemaAnalysisRuleFluentBuilder

Constructs a fluent builder for the BatchGetSchemaAnalysisRule operation.

Source§

impl Client

Source

pub fn create_analysis_template(&self) -> CreateAnalysisTemplateFluentBuilder

Constructs a fluent builder for the CreateAnalysisTemplate operation.

Source§

impl Client

Source

pub fn create_collaboration(&self) -> CreateCollaborationFluentBuilder

Constructs a fluent builder for the CreateCollaboration operation.

Source§

impl Client

Source

pub fn create_collaboration_change_request( &self, ) -> CreateCollaborationChangeRequestFluentBuilder

Constructs a fluent builder for the CreateCollaborationChangeRequest operation.

Source§

impl Client

Source

pub fn create_configured_audience_model_association( &self, ) -> CreateConfiguredAudienceModelAssociationFluentBuilder

Constructs a fluent builder for the CreateConfiguredAudienceModelAssociation operation.

Source§

impl Client

Source

pub fn create_configured_table(&self) -> CreateConfiguredTableFluentBuilder

Constructs a fluent builder for the CreateConfiguredTable operation.

Source§

impl Client

Source

pub fn create_configured_table_analysis_rule( &self, ) -> CreateConfiguredTableAnalysisRuleFluentBuilder

Constructs a fluent builder for the CreateConfiguredTableAnalysisRule operation.

Source§

impl Client

Source

pub fn create_configured_table_association( &self, ) -> CreateConfiguredTableAssociationFluentBuilder

Constructs a fluent builder for the CreateConfiguredTableAssociation operation.

Source§

impl Client

Source

pub fn create_configured_table_association_analysis_rule( &self, ) -> CreateConfiguredTableAssociationAnalysisRuleFluentBuilder

Constructs a fluent builder for the CreateConfiguredTableAssociationAnalysisRule operation.

Source§

impl Client

Source

pub fn create_id_mapping_table(&self) -> CreateIdMappingTableFluentBuilder

Constructs a fluent builder for the CreateIdMappingTable operation.

Source§

impl Client

Source

pub fn create_id_namespace_association( &self, ) -> CreateIdNamespaceAssociationFluentBuilder

Constructs a fluent builder for the CreateIdNamespaceAssociation operation.

Source§

impl Client

Source

pub fn create_membership(&self) -> CreateMembershipFluentBuilder

Constructs a fluent builder for the CreateMembership operation.

Source§

impl Client

Source

pub fn create_privacy_budget_template( &self, ) -> CreatePrivacyBudgetTemplateFluentBuilder

Constructs a fluent builder for the CreatePrivacyBudgetTemplate operation.

Source§

impl Client

Source

pub fn delete_analysis_template(&self) -> DeleteAnalysisTemplateFluentBuilder

Constructs a fluent builder for the DeleteAnalysisTemplate operation.

Source§

impl Client

Source

pub fn delete_collaboration(&self) -> DeleteCollaborationFluentBuilder

Constructs a fluent builder for the DeleteCollaboration operation.

Source§

impl Client

Source

pub fn delete_configured_audience_model_association( &self, ) -> DeleteConfiguredAudienceModelAssociationFluentBuilder

Constructs a fluent builder for the DeleteConfiguredAudienceModelAssociation operation.

Source§

impl Client

Source

pub fn delete_configured_table(&self) -> DeleteConfiguredTableFluentBuilder

Constructs a fluent builder for the DeleteConfiguredTable operation.

Source§

impl Client

Source

pub fn delete_configured_table_analysis_rule( &self, ) -> DeleteConfiguredTableAnalysisRuleFluentBuilder

Constructs a fluent builder for the DeleteConfiguredTableAnalysisRule operation.

Source§

impl Client

Source

pub fn delete_configured_table_association( &self, ) -> DeleteConfiguredTableAssociationFluentBuilder

Constructs a fluent builder for the DeleteConfiguredTableAssociation operation.

Source§

impl Client

Source

pub fn delete_configured_table_association_analysis_rule( &self, ) -> DeleteConfiguredTableAssociationAnalysisRuleFluentBuilder

Constructs a fluent builder for the DeleteConfiguredTableAssociationAnalysisRule operation.

Source§

impl Client

Source

pub fn delete_id_mapping_table(&self) -> DeleteIdMappingTableFluentBuilder

Constructs a fluent builder for the DeleteIdMappingTable operation.

Source§

impl Client

Source

pub fn delete_id_namespace_association( &self, ) -> DeleteIdNamespaceAssociationFluentBuilder

Constructs a fluent builder for the DeleteIdNamespaceAssociation operation.

Source§

impl Client

Source

pub fn delete_member(&self) -> DeleteMemberFluentBuilder

Constructs a fluent builder for the DeleteMember operation.

Source§

impl Client

Source

pub fn delete_membership(&self) -> DeleteMembershipFluentBuilder

Constructs a fluent builder for the DeleteMembership operation.

Source§

impl Client

Source

pub fn delete_privacy_budget_template( &self, ) -> DeletePrivacyBudgetTemplateFluentBuilder

Constructs a fluent builder for the DeletePrivacyBudgetTemplate operation.

Source§

impl Client

Source

pub fn get_analysis_template(&self) -> GetAnalysisTemplateFluentBuilder

Constructs a fluent builder for the GetAnalysisTemplate operation.

Source§

impl Client

Source

pub fn get_collaboration(&self) -> GetCollaborationFluentBuilder

Constructs a fluent builder for the GetCollaboration operation.

Source§

impl Client

Source

pub fn get_collaboration_analysis_template( &self, ) -> GetCollaborationAnalysisTemplateFluentBuilder

Constructs a fluent builder for the GetCollaborationAnalysisTemplate operation.

Source§

impl Client

Source

pub fn get_collaboration_change_request( &self, ) -> GetCollaborationChangeRequestFluentBuilder

Constructs a fluent builder for the GetCollaborationChangeRequest operation.

Source§

impl Client

Source

pub fn get_collaboration_configured_audience_model_association( &self, ) -> GetCollaborationConfiguredAudienceModelAssociationFluentBuilder

Constructs a fluent builder for the GetCollaborationConfiguredAudienceModelAssociation operation.

Source§

impl Client

Source

pub fn get_collaboration_id_namespace_association( &self, ) -> GetCollaborationIdNamespaceAssociationFluentBuilder

Constructs a fluent builder for the GetCollaborationIdNamespaceAssociation operation.

Source§

impl Client

Source

pub fn get_collaboration_privacy_budget_template( &self, ) -> GetCollaborationPrivacyBudgetTemplateFluentBuilder

Constructs a fluent builder for the GetCollaborationPrivacyBudgetTemplate operation.

Source§

impl Client

Source

pub fn get_configured_audience_model_association( &self, ) -> GetConfiguredAudienceModelAssociationFluentBuilder

Constructs a fluent builder for the GetConfiguredAudienceModelAssociation operation.

Source§

impl Client

Source

pub fn get_configured_table(&self) -> GetConfiguredTableFluentBuilder

Constructs a fluent builder for the GetConfiguredTable operation.

Source§

impl Client

Source

pub fn get_configured_table_analysis_rule( &self, ) -> GetConfiguredTableAnalysisRuleFluentBuilder

Constructs a fluent builder for the GetConfiguredTableAnalysisRule operation.

Source§

impl Client

Source

pub fn get_configured_table_association( &self, ) -> GetConfiguredTableAssociationFluentBuilder

Constructs a fluent builder for the GetConfiguredTableAssociation operation.

Source§

impl Client

Source

pub fn get_configured_table_association_analysis_rule( &self, ) -> GetConfiguredTableAssociationAnalysisRuleFluentBuilder

Constructs a fluent builder for the GetConfiguredTableAssociationAnalysisRule operation.

Source§

impl Client

Source

pub fn get_id_mapping_table(&self) -> GetIdMappingTableFluentBuilder

Constructs a fluent builder for the GetIdMappingTable operation.

Source§

impl Client

Source

pub fn get_id_namespace_association( &self, ) -> GetIdNamespaceAssociationFluentBuilder

Constructs a fluent builder for the GetIdNamespaceAssociation operation.

Source§

impl Client

Source

pub fn get_membership(&self) -> GetMembershipFluentBuilder

Constructs a fluent builder for the GetMembership operation.

Source§

impl Client

Source

pub fn get_privacy_budget_template( &self, ) -> GetPrivacyBudgetTemplateFluentBuilder

Constructs a fluent builder for the GetPrivacyBudgetTemplate operation.

Source§

impl Client

Source

pub fn get_protected_job(&self) -> GetProtectedJobFluentBuilder

Constructs a fluent builder for the GetProtectedJob operation.

Source§

impl Client

Source

pub fn get_protected_query(&self) -> GetProtectedQueryFluentBuilder

Constructs a fluent builder for the GetProtectedQuery operation.

Source§

impl Client

Source

pub fn get_schema(&self) -> GetSchemaFluentBuilder

Constructs a fluent builder for the GetSchema operation.

Source§

impl Client

Source

pub fn get_schema_analysis_rule(&self) -> GetSchemaAnalysisRuleFluentBuilder

Constructs a fluent builder for the GetSchemaAnalysisRule operation.

Source§

impl Client

Source

pub fn list_analysis_templates(&self) -> ListAnalysisTemplatesFluentBuilder

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

Source§

impl Client

Source

pub fn list_collaboration_analysis_templates( &self, ) -> ListCollaborationAnalysisTemplatesFluentBuilder

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

Source§

impl Client

Source

pub fn list_collaboration_change_requests( &self, ) -> ListCollaborationChangeRequestsFluentBuilder

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

Source§

impl Client

Source

pub fn list_collaboration_configured_audience_model_associations( &self, ) -> ListCollaborationConfiguredAudienceModelAssociationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_collaboration_id_namespace_associations( &self, ) -> ListCollaborationIdNamespaceAssociationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_collaboration_privacy_budget_templates( &self, ) -> ListCollaborationPrivacyBudgetTemplatesFluentBuilder

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

Source§

impl Client

Source

pub fn list_collaboration_privacy_budgets( &self, ) -> ListCollaborationPrivacyBudgetsFluentBuilder

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

Source§

impl Client

Source

pub fn list_collaborations(&self) -> ListCollaborationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_configured_audience_model_associations( &self, ) -> ListConfiguredAudienceModelAssociationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_configured_table_associations( &self, ) -> ListConfiguredTableAssociationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_configured_tables(&self) -> ListConfiguredTablesFluentBuilder

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

Source§

impl Client

Source

pub fn list_id_mapping_tables(&self) -> ListIdMappingTablesFluentBuilder

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

Source§

impl Client

Source

pub fn list_id_namespace_associations( &self, ) -> ListIdNamespaceAssociationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_members(&self) -> ListMembersFluentBuilder

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

Source§

impl Client

Source

pub fn list_memberships(&self) -> ListMembershipsFluentBuilder

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

Source§

impl Client

Source

pub fn list_privacy_budget_templates( &self, ) -> ListPrivacyBudgetTemplatesFluentBuilder

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

Source§

impl Client

Source

pub fn list_privacy_budgets(&self) -> ListPrivacyBudgetsFluentBuilder

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

Source§

impl Client

Source

pub fn list_protected_jobs(&self) -> ListProtectedJobsFluentBuilder

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

Source§

impl Client

Source

pub fn list_protected_queries(&self) -> ListProtectedQueriesFluentBuilder

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

Source§

impl Client

Source

pub fn list_schemas(&self) -> ListSchemasFluentBuilder

Constructs a fluent builder for the ListSchemas 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.

Source§

impl Client

Source

pub fn populate_id_mapping_table(&self) -> PopulateIdMappingTableFluentBuilder

Constructs a fluent builder for the PopulateIdMappingTable operation.

Source§

impl Client

Source

pub fn preview_privacy_impact(&self) -> PreviewPrivacyImpactFluentBuilder

Constructs a fluent builder for the PreviewPrivacyImpact operation.

Source§

impl Client

Source

pub fn start_protected_job(&self) -> StartProtectedJobFluentBuilder

Constructs a fluent builder for the StartProtectedJob operation.

Source§

impl Client

Source

pub fn start_protected_query(&self) -> StartProtectedQueryFluentBuilder

Constructs a fluent builder for the StartProtectedQuery 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_analysis_template(&self) -> UpdateAnalysisTemplateFluentBuilder

Constructs a fluent builder for the UpdateAnalysisTemplate operation.

Source§

impl Client

Source

pub fn update_collaboration(&self) -> UpdateCollaborationFluentBuilder

Constructs a fluent builder for the UpdateCollaboration operation.

Source§

impl Client

Source

pub fn update_configured_audience_model_association( &self, ) -> UpdateConfiguredAudienceModelAssociationFluentBuilder

Constructs a fluent builder for the UpdateConfiguredAudienceModelAssociation operation.

Source§

impl Client

Source

pub fn update_configured_table(&self) -> UpdateConfiguredTableFluentBuilder

Constructs a fluent builder for the UpdateConfiguredTable operation.

Source§

impl Client

Source

pub fn update_configured_table_analysis_rule( &self, ) -> UpdateConfiguredTableAnalysisRuleFluentBuilder

Constructs a fluent builder for the UpdateConfiguredTableAnalysisRule operation.

Source§

impl Client

Source

pub fn update_configured_table_association( &self, ) -> UpdateConfiguredTableAssociationFluentBuilder

Constructs a fluent builder for the UpdateConfiguredTableAssociation operation.

Source§

impl Client

Source

pub fn update_configured_table_association_analysis_rule( &self, ) -> UpdateConfiguredTableAssociationAnalysisRuleFluentBuilder

Constructs a fluent builder for the UpdateConfiguredTableAssociationAnalysisRule operation.

Source§

impl Client

Source

pub fn update_id_mapping_table(&self) -> UpdateIdMappingTableFluentBuilder

Constructs a fluent builder for the UpdateIdMappingTable operation.

Source§

impl Client

Source

pub fn update_id_namespace_association( &self, ) -> UpdateIdNamespaceAssociationFluentBuilder

Constructs a fluent builder for the UpdateIdNamespaceAssociation operation.

Source§

impl Client

Source

pub fn update_membership(&self) -> UpdateMembershipFluentBuilder

Constructs a fluent builder for the UpdateMembership operation.

Source§

impl Client

Source

pub fn update_privacy_budget_template( &self, ) -> UpdatePrivacyBudgetTemplateFluentBuilder

Constructs a fluent builder for the UpdatePrivacyBudgetTemplate operation.

Source§

impl Client

Source

pub fn update_protected_job(&self) -> UpdateProtectedJobFluentBuilder

Constructs a fluent builder for the UpdateProtectedJob operation.

Source§

impl Client

Source

pub fn update_protected_query(&self) -> UpdateProtectedQueryFluentBuilder

Constructs a fluent builder for the UpdateProtectedQuery 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,