Client

Struct Client 

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

Client for Amazon Chime SDK Voice

Client for invoking operations on Amazon Chime SDK Voice. Each operation on Amazon Chime SDK Voice 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_chimesdkvoice::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_chimesdkvoice::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 AssociatePhoneNumbersWithVoiceConnector operation has a Client::associate_phone_numbers_with_voice_connector, 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.associate_phone_numbers_with_voice_connector()
    .voice_connector_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.

Implementations§

Source§

impl Client

Source

pub fn associate_phone_numbers_with_voice_connector( &self, ) -> AssociatePhoneNumbersWithVoiceConnectorFluentBuilder

Constructs a fluent builder for the AssociatePhoneNumbersWithVoiceConnector operation.

Source§

impl Client

Source

pub fn associate_phone_numbers_with_voice_connector_group( &self, ) -> AssociatePhoneNumbersWithVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the AssociatePhoneNumbersWithVoiceConnectorGroup operation.

Source§

impl Client

Source

pub fn batch_delete_phone_number(&self) -> BatchDeletePhoneNumberFluentBuilder

Constructs a fluent builder for the BatchDeletePhoneNumber operation.

Source§

impl Client

Source

pub fn batch_update_phone_number(&self) -> BatchUpdatePhoneNumberFluentBuilder

Constructs a fluent builder for the BatchUpdatePhoneNumber operation.

Source§

impl Client

Source

pub fn create_phone_number_order(&self) -> CreatePhoneNumberOrderFluentBuilder

Constructs a fluent builder for the CreatePhoneNumberOrder operation.

Source§

impl Client

Source

pub fn create_proxy_session(&self) -> CreateProxySessionFluentBuilder

Constructs a fluent builder for the CreateProxySession operation.

Source§

impl Client

Source

pub fn create_sip_media_application( &self, ) -> CreateSipMediaApplicationFluentBuilder

Constructs a fluent builder for the CreateSipMediaApplication operation.

Source§

impl Client

Source

pub fn create_sip_media_application_call( &self, ) -> CreateSipMediaApplicationCallFluentBuilder

Constructs a fluent builder for the CreateSipMediaApplicationCall operation.

Source§

impl Client

Source

pub fn create_sip_rule(&self) -> CreateSipRuleFluentBuilder

Constructs a fluent builder for the CreateSipRule operation.

Source§

impl Client

Source

pub fn create_voice_connector(&self) -> CreateVoiceConnectorFluentBuilder

Constructs a fluent builder for the CreateVoiceConnector operation.

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

      The name of the Voice Connector.


    • aws_region(VoiceConnectorAwsRegion) / set_aws_region(Option<VoiceConnectorAwsRegion>):
      required: false

      The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1 .


    • require_encryption(bool) / set_require_encryption(Option<bool>):
      required: true

      Enables or disables encryption for the Voice Connector.


    • tags(Tag) / set_tags(Option<Vec::<Tag>>):
      required: false

      The tags assigned to the Voice Connector.


    • integration_type(VoiceConnectorIntegrationType) / set_integration_type(Option<VoiceConnectorIntegrationType>):
      required: false

      The connectors for use with Amazon Connect.

      The following options are available:

      • CONNECT_CALL_TRANSFER_CONNECTOR - Enables enterprises to integrate Amazon Connect with other voice systems to directly transfer voice calls and metadata without using the public telephone network. They can use Amazon Connect telephony and Interactive Voice Response (IVR) with their existing voice systems to modernize the IVR experience of their existing contact center and their enterprise and branch voice systems. Additionally, enterprises migrating their contact center to Amazon Connect can start with Connect telephony and IVR for immediate modernization ahead of agent migration.

      • CONNECT_ANALYTICS_CONNECTOR - Enables enterprises to integrate Amazon Connect with other voice systems for real-time and post-call analytics. They can use Amazon Connect Contact Lens with their existing voice systems to provides call recordings, conversational analytics (including contact transcript, sensitive data redaction, content categorization, theme detection, sentiment analysis, real-time alerts, and post-contact summary), and agent performance evaluations (including evaluation forms, automated evaluation, supervisor review) with a rich user experience to display, search and filter customer interactions, and programmatic access to data streams and the data lake. Additionally, enterprises migrating their contact center to Amazon Connect can start with Contact Lens analytics and performance insights ahead of agent migration.


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

impl Client

Source

pub fn create_voice_connector_group( &self, ) -> CreateVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the CreateVoiceConnectorGroup operation.

Source§

impl Client

Source

pub fn create_voice_profile(&self) -> CreateVoiceProfileFluentBuilder

Constructs a fluent builder for the CreateVoiceProfile operation.

Source§

impl Client

Source

pub fn create_voice_profile_domain( &self, ) -> CreateVoiceProfileDomainFluentBuilder

Constructs a fluent builder for the CreateVoiceProfileDomain operation.

Source§

impl Client

Source

pub fn delete_phone_number(&self) -> DeletePhoneNumberFluentBuilder

Constructs a fluent builder for the DeletePhoneNumber operation.

Source§

impl Client

Source

pub fn delete_proxy_session(&self) -> DeleteProxySessionFluentBuilder

Constructs a fluent builder for the DeleteProxySession operation.

Source§

impl Client

Source

pub fn delete_sip_media_application( &self, ) -> DeleteSipMediaApplicationFluentBuilder

Constructs a fluent builder for the DeleteSipMediaApplication operation.

Source§

impl Client

Source

pub fn delete_sip_rule(&self) -> DeleteSipRuleFluentBuilder

Constructs a fluent builder for the DeleteSipRule operation.

Source§

impl Client

Source

pub fn delete_voice_connector(&self) -> DeleteVoiceConnectorFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnector operation.

Source§

impl Client

Source§

impl Client

Source

pub fn delete_voice_connector_external_systems_configuration( &self, ) -> DeleteVoiceConnectorExternalSystemsConfigurationFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorExternalSystemsConfiguration operation.

Source§

impl Client

Source

pub fn delete_voice_connector_group( &self, ) -> DeleteVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorGroup operation.

Source§

impl Client

Source

pub fn delete_voice_connector_origination( &self, ) -> DeleteVoiceConnectorOriginationFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorOrigination operation.

Source§

impl Client

Source

pub fn delete_voice_connector_proxy( &self, ) -> DeleteVoiceConnectorProxyFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorProxy operation.

Source§

impl Client

Source§

impl Client

Source

pub fn delete_voice_connector_termination( &self, ) -> DeleteVoiceConnectorTerminationFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorTermination operation.

Source§

impl Client

Source

pub fn delete_voice_connector_termination_credentials( &self, ) -> DeleteVoiceConnectorTerminationCredentialsFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorTerminationCredentials operation.

Source§

impl Client

Source

pub fn delete_voice_profile(&self) -> DeleteVoiceProfileFluentBuilder

Constructs a fluent builder for the DeleteVoiceProfile operation.

Source§

impl Client

Source

pub fn delete_voice_profile_domain( &self, ) -> DeleteVoiceProfileDomainFluentBuilder

Constructs a fluent builder for the DeleteVoiceProfileDomain operation.

Source§

impl Client

Source

pub fn disassociate_phone_numbers_from_voice_connector( &self, ) -> DisassociatePhoneNumbersFromVoiceConnectorFluentBuilder

Constructs a fluent builder for the DisassociatePhoneNumbersFromVoiceConnector operation.

Source§

impl Client

Source

pub fn disassociate_phone_numbers_from_voice_connector_group( &self, ) -> DisassociatePhoneNumbersFromVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the DisassociatePhoneNumbersFromVoiceConnectorGroup operation.

Source§

impl Client

Source

pub fn get_global_settings(&self) -> GetGlobalSettingsFluentBuilder

Constructs a fluent builder for the GetGlobalSettings operation.

Source§

impl Client

Source

pub fn get_phone_number(&self) -> GetPhoneNumberFluentBuilder

Constructs a fluent builder for the GetPhoneNumber operation.

Source§

impl Client

Source

pub fn get_phone_number_order(&self) -> GetPhoneNumberOrderFluentBuilder

Constructs a fluent builder for the GetPhoneNumberOrder operation.

Source§

impl Client

Source

pub fn get_phone_number_settings(&self) -> GetPhoneNumberSettingsFluentBuilder

Constructs a fluent builder for the GetPhoneNumberSettings operation.

Source§

impl Client

Source

pub fn get_proxy_session(&self) -> GetProxySessionFluentBuilder

Constructs a fluent builder for the GetProxySession operation.

Source§

impl Client

Source

pub fn get_sip_media_application(&self) -> GetSipMediaApplicationFluentBuilder

Constructs a fluent builder for the GetSipMediaApplication operation.

Source§

impl Client

Source

pub fn get_sip_media_application_alexa_skill_configuration( &self, ) -> GetSipMediaApplicationAlexaSkillConfigurationFluentBuilder

👎Deprecated: Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties).

Constructs a fluent builder for the GetSipMediaApplicationAlexaSkillConfiguration operation.

Source§

impl Client

Source§

impl Client

Source

pub fn get_sip_rule(&self) -> GetSipRuleFluentBuilder

Constructs a fluent builder for the GetSipRule operation.

Source§

impl Client

Source

pub fn get_speaker_search_task(&self) -> GetSpeakerSearchTaskFluentBuilder

Constructs a fluent builder for the GetSpeakerSearchTask operation.

Source§

impl Client

Source

pub fn get_voice_connector(&self) -> GetVoiceConnectorFluentBuilder

Constructs a fluent builder for the GetVoiceConnector operation.

Source§

impl Client

Source§

impl Client

Source

pub fn get_voice_connector_external_systems_configuration( &self, ) -> GetVoiceConnectorExternalSystemsConfigurationFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorExternalSystemsConfiguration operation.

Source§

impl Client

Source

pub fn get_voice_connector_group(&self) -> GetVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorGroup operation.

Source§

impl Client

Source

pub fn get_voice_connector_logging_configuration( &self, ) -> GetVoiceConnectorLoggingConfigurationFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorLoggingConfiguration operation.

Source§

impl Client

Source

pub fn get_voice_connector_origination( &self, ) -> GetVoiceConnectorOriginationFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorOrigination operation.

Source§

impl Client

Source

pub fn get_voice_connector_proxy(&self) -> GetVoiceConnectorProxyFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorProxy operation.

Source§

impl Client

Source

pub fn get_voice_connector_streaming_configuration( &self, ) -> GetVoiceConnectorStreamingConfigurationFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorStreamingConfiguration operation.

Source§

impl Client

Source

pub fn get_voice_connector_termination( &self, ) -> GetVoiceConnectorTerminationFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorTermination operation.

Source§

impl Client

Source

pub fn get_voice_connector_termination_health( &self, ) -> GetVoiceConnectorTerminationHealthFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorTerminationHealth operation.

Source§

impl Client

Source

pub fn get_voice_profile(&self) -> GetVoiceProfileFluentBuilder

Constructs a fluent builder for the GetVoiceProfile operation.

Source§

impl Client

Source

pub fn get_voice_profile_domain(&self) -> GetVoiceProfileDomainFluentBuilder

Constructs a fluent builder for the GetVoiceProfileDomain operation.

Source§

impl Client

Source

pub fn get_voice_tone_analysis_task( &self, ) -> GetVoiceToneAnalysisTaskFluentBuilder

Constructs a fluent builder for the GetVoiceToneAnalysisTask operation.

Source§

impl Client

Source

pub fn list_available_voice_connector_regions( &self, ) -> ListAvailableVoiceConnectorRegionsFluentBuilder

Constructs a fluent builder for the ListAvailableVoiceConnectorRegions operation.

Source§

impl Client

Source

pub fn list_phone_number_orders(&self) -> ListPhoneNumberOrdersFluentBuilder

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

Source§

impl Client

Source

pub fn list_phone_numbers(&self) -> ListPhoneNumbersFluentBuilder

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

Source§

impl Client

Source

pub fn list_proxy_sessions(&self) -> ListProxySessionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_sip_media_applications( &self, ) -> ListSipMediaApplicationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_sip_rules(&self) -> ListSipRulesFluentBuilder

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

Source§

impl Client

Source

pub fn list_supported_phone_number_countries( &self, ) -> ListSupportedPhoneNumberCountriesFluentBuilder

Constructs a fluent builder for the ListSupportedPhoneNumberCountries 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 list_voice_connector_groups( &self, ) -> ListVoiceConnectorGroupsFluentBuilder

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

Source§

impl Client

Source

pub fn list_voice_connector_termination_credentials( &self, ) -> ListVoiceConnectorTerminationCredentialsFluentBuilder

Constructs a fluent builder for the ListVoiceConnectorTerminationCredentials operation.

Source§

impl Client

Source

pub fn list_voice_connectors(&self) -> ListVoiceConnectorsFluentBuilder

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

Source§

impl Client

Source

pub fn list_voice_profile_domains(&self) -> ListVoiceProfileDomainsFluentBuilder

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

Source§

impl Client

Source

pub fn list_voice_profiles(&self) -> ListVoiceProfilesFluentBuilder

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

Source§

impl Client

Source

pub fn put_sip_media_application_alexa_skill_configuration( &self, ) -> PutSipMediaApplicationAlexaSkillConfigurationFluentBuilder

👎Deprecated: Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties).
Source§

impl Client

Source§

impl Client

Source§

impl Client

Source

pub fn put_voice_connector_external_systems_configuration( &self, ) -> PutVoiceConnectorExternalSystemsConfigurationFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorExternalSystemsConfiguration operation.

Source§

impl Client

Source

pub fn put_voice_connector_logging_configuration( &self, ) -> PutVoiceConnectorLoggingConfigurationFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorLoggingConfiguration operation.

Source§

impl Client

Source

pub fn put_voice_connector_origination( &self, ) -> PutVoiceConnectorOriginationFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorOrigination operation.

Source§

impl Client

Source

pub fn put_voice_connector_proxy(&self) -> PutVoiceConnectorProxyFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorProxy operation.

Source§

impl Client

Source§

impl Client

Source

pub fn put_voice_connector_termination( &self, ) -> PutVoiceConnectorTerminationFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorTermination operation.

Source§

impl Client

Source

pub fn put_voice_connector_termination_credentials( &self, ) -> PutVoiceConnectorTerminationCredentialsFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorTerminationCredentials operation.

Source§

impl Client

Source

pub fn restore_phone_number(&self) -> RestorePhoneNumberFluentBuilder

Constructs a fluent builder for the RestorePhoneNumber operation.

Source§

impl Client

Source

pub fn search_available_phone_numbers( &self, ) -> SearchAvailablePhoneNumbersFluentBuilder

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

Source§

impl Client

Source

pub fn start_speaker_search_task(&self) -> StartSpeakerSearchTaskFluentBuilder

Constructs a fluent builder for the StartSpeakerSearchTask operation.

Source§

impl Client

Source

pub fn start_voice_tone_analysis_task( &self, ) -> StartVoiceToneAnalysisTaskFluentBuilder

Constructs a fluent builder for the StartVoiceToneAnalysisTask operation.

Source§

impl Client

Source

pub fn stop_speaker_search_task(&self) -> StopSpeakerSearchTaskFluentBuilder

Constructs a fluent builder for the StopSpeakerSearchTask operation.

Source§

impl Client

Source

pub fn stop_voice_tone_analysis_task( &self, ) -> StopVoiceToneAnalysisTaskFluentBuilder

Constructs a fluent builder for the StopVoiceToneAnalysisTask 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_global_settings(&self) -> UpdateGlobalSettingsFluentBuilder

Constructs a fluent builder for the UpdateGlobalSettings operation.

Source§

impl Client

Source

pub fn update_phone_number(&self) -> UpdatePhoneNumberFluentBuilder

Constructs a fluent builder for the UpdatePhoneNumber operation.

Source§

impl Client

Source

pub fn update_phone_number_settings( &self, ) -> UpdatePhoneNumberSettingsFluentBuilder

Constructs a fluent builder for the UpdatePhoneNumberSettings operation.

Source§

impl Client

Source

pub fn update_proxy_session(&self) -> UpdateProxySessionFluentBuilder

Constructs a fluent builder for the UpdateProxySession operation.

Source§

impl Client

Source

pub fn update_sip_media_application( &self, ) -> UpdateSipMediaApplicationFluentBuilder

Constructs a fluent builder for the UpdateSipMediaApplication operation.

Source§

impl Client

Source

pub fn update_sip_media_application_call( &self, ) -> UpdateSipMediaApplicationCallFluentBuilder

Constructs a fluent builder for the UpdateSipMediaApplicationCall operation.

Source§

impl Client

Source

pub fn update_sip_rule(&self) -> UpdateSipRuleFluentBuilder

Constructs a fluent builder for the UpdateSipRule operation.

Source§

impl Client

Source

pub fn update_voice_connector(&self) -> UpdateVoiceConnectorFluentBuilder

Constructs a fluent builder for the UpdateVoiceConnector operation.

Source§

impl Client

Source

pub fn update_voice_connector_group( &self, ) -> UpdateVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the UpdateVoiceConnectorGroup operation.

Source§

impl Client

Source

pub fn update_voice_profile(&self) -> UpdateVoiceProfileFluentBuilder

Constructs a fluent builder for the UpdateVoiceProfile operation.

Source§

impl Client

Source

pub fn update_voice_profile_domain( &self, ) -> UpdateVoiceProfileDomainFluentBuilder

Constructs a fluent builder for the UpdateVoiceProfileDomain operation.

Source§

impl Client

Source

pub fn validate_e911_address(&self) -> ValidateE911AddressFluentBuilder

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