Client

Struct Client 

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

Client for Amazon Bedrock

Client for invoking operations on Amazon Bedrock. Each operation on Amazon Bedrock 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_bedrock::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_bedrock::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 CancelAutomatedReasoningPolicyBuildWorkflow operation has a Client::cancel_automated_reasoning_policy_build_workflow, 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.cancel_automated_reasoning_policy_build_workflow()
    .policy_arn("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_delete_evaluation_job( &self, ) -> BatchDeleteEvaluationJobFluentBuilder

Constructs a fluent builder for the BatchDeleteEvaluationJob operation.

Source§

impl Client

Source

pub fn cancel_automated_reasoning_policy_build_workflow( &self, ) -> CancelAutomatedReasoningPolicyBuildWorkflowFluentBuilder

Constructs a fluent builder for the CancelAutomatedReasoningPolicyBuildWorkflow operation.

Source§

impl Client

Source

pub fn create_automated_reasoning_policy( &self, ) -> CreateAutomatedReasoningPolicyFluentBuilder

Constructs a fluent builder for the CreateAutomatedReasoningPolicy operation.

Source§

impl Client

Source

pub fn create_automated_reasoning_policy_test_case( &self, ) -> CreateAutomatedReasoningPolicyTestCaseFluentBuilder

Constructs a fluent builder for the CreateAutomatedReasoningPolicyTestCase operation.

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

      The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to create the test.


    • guard_content(impl Into<String>) / set_guard_content(Option<String>):
      required: true

      The output content that’s validated by the Automated Reasoning policy. This represents the foundation model response that will be checked for accuracy.


    • query_content(impl Into<String>) / set_query_content(Option<String>):
      required: false

      The input query or prompt that generated the content. This provides context for the validation.


    • expected_aggregated_findings_result(AutomatedReasoningCheckResult) / set_expected_aggregated_findings_result(Option<AutomatedReasoningCheckResult>):
      required: true

      The expected result of the Automated Reasoning check. Valid values include: , TOO_COMPLEX, and NO_TRANSLATIONS.

      • VALID - The claims are true. The claims are implied by the premises and the Automated Reasoning policy. Given the Automated Reasoning policy and premises, it is not possible for these claims to be false. In other words, there are no alternative answers that are true that contradict the claims.

      • INVALID - The claims are false. The claims are not implied by the premises and Automated Reasoning policy. Furthermore, there exists different claims that are consistent with the premises and Automated Reasoning policy.

      • SATISFIABLE - The claims can be true or false. It depends on what assumptions are made for the claim to be implied from the premises and Automated Reasoning policy rules. In this situation, different assumptions can make input claims false and alternative claims true.

      • IMPOSSIBLE - Automated Reasoning can’t make a statement about the claims. This can happen if the premises are logically incorrect, or if there is a conflict within the Automated Reasoning policy itself.

      • TRANSLATION_AMBIGUOUS - Detected an ambiguity in the translation meant it would be unsound to continue with validity checking. Additional context or follow-up questions might be needed to get translation to succeed.

      • TOO_COMPLEX - The input contains too much information for Automated Reasoning to process within its latency limits.

      • NO_TRANSLATIONS - Identifies that some or all of the input prompt wasn’t translated into logic. This can happen if the input isn’t relevant to the Automated Reasoning policy, or if the policy doesn’t have variables to model relevant input. If Automated Reasoning can’t translate anything, you get a single NO_TRANSLATIONS finding. You might also see a NO_TRANSLATIONS (along with other findings) if some part of the validation isn’t translated.


    • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
      required: false

      A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.


    • confidence_threshold(f64) / set_confidence_threshold(Option<f64>):
      required: false

      The minimum confidence level for logic validation. Content that meets the threshold is considered a high-confidence finding that can be validated.


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

impl Client

Source

pub fn create_automated_reasoning_policy_version( &self, ) -> CreateAutomatedReasoningPolicyVersionFluentBuilder

Constructs a fluent builder for the CreateAutomatedReasoningPolicyVersion operation.

Source§

impl Client

Source

pub fn create_custom_model(&self) -> CreateCustomModelFluentBuilder

Constructs a fluent builder for the CreateCustomModel operation.

Source§

impl Client

Source

pub fn create_custom_model_deployment( &self, ) -> CreateCustomModelDeploymentFluentBuilder

Constructs a fluent builder for the CreateCustomModelDeployment operation.

Source§

impl Client

Source

pub fn create_evaluation_job(&self) -> CreateEvaluationJobFluentBuilder

Constructs a fluent builder for the CreateEvaluationJob operation.

Source§

impl Client

Source

pub fn create_foundation_model_agreement( &self, ) -> CreateFoundationModelAgreementFluentBuilder

Constructs a fluent builder for the CreateFoundationModelAgreement operation.

Source§

impl Client

Source

pub fn create_guardrail(&self) -> CreateGuardrailFluentBuilder

Constructs a fluent builder for the CreateGuardrail operation.

Source§

impl Client

Source

pub fn create_guardrail_version(&self) -> CreateGuardrailVersionFluentBuilder

Constructs a fluent builder for the CreateGuardrailVersion operation.

Source§

impl Client

Source

pub fn create_inference_profile(&self) -> CreateInferenceProfileFluentBuilder

Constructs a fluent builder for the CreateInferenceProfile operation.

Source§

impl Client

Source

pub fn create_marketplace_model_endpoint( &self, ) -> CreateMarketplaceModelEndpointFluentBuilder

Constructs a fluent builder for the CreateMarketplaceModelEndpoint operation.

Source§

impl Client

Source

pub fn create_model_copy_job(&self) -> CreateModelCopyJobFluentBuilder

Constructs a fluent builder for the CreateModelCopyJob operation.

Source§

impl Client

Source

pub fn create_model_customization_job( &self, ) -> CreateModelCustomizationJobFluentBuilder

Constructs a fluent builder for the CreateModelCustomizationJob operation.

Source§

impl Client

Source

pub fn create_model_import_job(&self) -> CreateModelImportJobFluentBuilder

Constructs a fluent builder for the CreateModelImportJob operation.

Source§

impl Client

Source

pub fn create_model_invocation_job( &self, ) -> CreateModelInvocationJobFluentBuilder

Constructs a fluent builder for the CreateModelInvocationJob operation.

Source§

impl Client

Source

pub fn create_prompt_router(&self) -> CreatePromptRouterFluentBuilder

Constructs a fluent builder for the CreatePromptRouter operation.

Source§

impl Client

Source

pub fn create_provisioned_model_throughput( &self, ) -> CreateProvisionedModelThroughputFluentBuilder

Constructs a fluent builder for the CreateProvisionedModelThroughput operation.

Source§

impl Client

Source

pub fn delete_automated_reasoning_policy( &self, ) -> DeleteAutomatedReasoningPolicyFluentBuilder

Constructs a fluent builder for the DeleteAutomatedReasoningPolicy operation.

Source§

impl Client

Source

pub fn delete_automated_reasoning_policy_build_workflow( &self, ) -> DeleteAutomatedReasoningPolicyBuildWorkflowFluentBuilder

Constructs a fluent builder for the DeleteAutomatedReasoningPolicyBuildWorkflow operation.

Source§

impl Client

Source

pub fn delete_automated_reasoning_policy_test_case( &self, ) -> DeleteAutomatedReasoningPolicyTestCaseFluentBuilder

Constructs a fluent builder for the DeleteAutomatedReasoningPolicyTestCase operation.

Source§

impl Client

Source

pub fn delete_custom_model(&self) -> DeleteCustomModelFluentBuilder

Constructs a fluent builder for the DeleteCustomModel operation.

Source§

impl Client

Source

pub fn delete_custom_model_deployment( &self, ) -> DeleteCustomModelDeploymentFluentBuilder

Constructs a fluent builder for the DeleteCustomModelDeployment operation.

Source§

impl Client

Source

pub fn delete_foundation_model_agreement( &self, ) -> DeleteFoundationModelAgreementFluentBuilder

Constructs a fluent builder for the DeleteFoundationModelAgreement operation.

Source§

impl Client

Source

pub fn delete_guardrail(&self) -> DeleteGuardrailFluentBuilder

Constructs a fluent builder for the DeleteGuardrail operation.

Source§

impl Client

Source

pub fn delete_imported_model(&self) -> DeleteImportedModelFluentBuilder

Constructs a fluent builder for the DeleteImportedModel operation.

Source§

impl Client

Source

pub fn delete_inference_profile(&self) -> DeleteInferenceProfileFluentBuilder

Constructs a fluent builder for the DeleteInferenceProfile operation.

Source§

impl Client

Source

pub fn delete_marketplace_model_endpoint( &self, ) -> DeleteMarketplaceModelEndpointFluentBuilder

Constructs a fluent builder for the DeleteMarketplaceModelEndpoint operation.

Source§

impl Client

Source§

impl Client

Source

pub fn delete_prompt_router(&self) -> DeletePromptRouterFluentBuilder

Constructs a fluent builder for the DeletePromptRouter operation.

Source§

impl Client

Source

pub fn delete_provisioned_model_throughput( &self, ) -> DeleteProvisionedModelThroughputFluentBuilder

Constructs a fluent builder for the DeleteProvisionedModelThroughput operation.

Source§

impl Client

Source

pub fn deregister_marketplace_model_endpoint( &self, ) -> DeregisterMarketplaceModelEndpointFluentBuilder

Constructs a fluent builder for the DeregisterMarketplaceModelEndpoint operation.

Source§

impl Client

Source

pub fn export_automated_reasoning_policy_version( &self, ) -> ExportAutomatedReasoningPolicyVersionFluentBuilder

Constructs a fluent builder for the ExportAutomatedReasoningPolicyVersion operation.

Source§

impl Client

Source

pub fn get_automated_reasoning_policy( &self, ) -> GetAutomatedReasoningPolicyFluentBuilder

Constructs a fluent builder for the GetAutomatedReasoningPolicy operation.

Source§

impl Client

Source

pub fn get_automated_reasoning_policy_annotations( &self, ) -> GetAutomatedReasoningPolicyAnnotationsFluentBuilder

Constructs a fluent builder for the GetAutomatedReasoningPolicyAnnotations operation.

Source§

impl Client

Source

pub fn get_automated_reasoning_policy_build_workflow( &self, ) -> GetAutomatedReasoningPolicyBuildWorkflowFluentBuilder

Constructs a fluent builder for the GetAutomatedReasoningPolicyBuildWorkflow operation.

Source§

impl Client

Source

pub fn get_automated_reasoning_policy_build_workflow_result_assets( &self, ) -> GetAutomatedReasoningPolicyBuildWorkflowResultAssetsFluentBuilder

Constructs a fluent builder for the GetAutomatedReasoningPolicyBuildWorkflowResultAssets operation.

Source§

impl Client

Source

pub fn get_automated_reasoning_policy_next_scenario( &self, ) -> GetAutomatedReasoningPolicyNextScenarioFluentBuilder

Constructs a fluent builder for the GetAutomatedReasoningPolicyNextScenario operation.

Source§

impl Client

Source

pub fn get_automated_reasoning_policy_test_case( &self, ) -> GetAutomatedReasoningPolicyTestCaseFluentBuilder

Constructs a fluent builder for the GetAutomatedReasoningPolicyTestCase operation.

Source§

impl Client

Source

pub fn get_automated_reasoning_policy_test_result( &self, ) -> GetAutomatedReasoningPolicyTestResultFluentBuilder

Constructs a fluent builder for the GetAutomatedReasoningPolicyTestResult operation.

Source§

impl Client

Source

pub fn get_custom_model(&self) -> GetCustomModelFluentBuilder

Constructs a fluent builder for the GetCustomModel operation.

Source§

impl Client

Source

pub fn get_custom_model_deployment( &self, ) -> GetCustomModelDeploymentFluentBuilder

Constructs a fluent builder for the GetCustomModelDeployment operation.

Source§

impl Client

Source

pub fn get_evaluation_job(&self) -> GetEvaluationJobFluentBuilder

Constructs a fluent builder for the GetEvaluationJob operation.

Source§

impl Client

Source

pub fn get_foundation_model(&self) -> GetFoundationModelFluentBuilder

Constructs a fluent builder for the GetFoundationModel operation.

Source§

impl Client

Source

pub fn get_foundation_model_availability( &self, ) -> GetFoundationModelAvailabilityFluentBuilder

Constructs a fluent builder for the GetFoundationModelAvailability operation.

Source§

impl Client

Source

pub fn get_guardrail(&self) -> GetGuardrailFluentBuilder

Constructs a fluent builder for the GetGuardrail operation.

Source§

impl Client

Source

pub fn get_imported_model(&self) -> GetImportedModelFluentBuilder

Constructs a fluent builder for the GetImportedModel operation.

Source§

impl Client

Source

pub fn get_inference_profile(&self) -> GetInferenceProfileFluentBuilder

Constructs a fluent builder for the GetInferenceProfile operation.

Source§

impl Client

Source

pub fn get_marketplace_model_endpoint( &self, ) -> GetMarketplaceModelEndpointFluentBuilder

Constructs a fluent builder for the GetMarketplaceModelEndpoint operation.

Source§

impl Client

Source

pub fn get_model_copy_job(&self) -> GetModelCopyJobFluentBuilder

Constructs a fluent builder for the GetModelCopyJob operation.

Source§

impl Client

Source

pub fn get_model_customization_job( &self, ) -> GetModelCustomizationJobFluentBuilder

Constructs a fluent builder for the GetModelCustomizationJob operation.

Source§

impl Client

Source

pub fn get_model_import_job(&self) -> GetModelImportJobFluentBuilder

Constructs a fluent builder for the GetModelImportJob operation.

Source§

impl Client

Source

pub fn get_model_invocation_job(&self) -> GetModelInvocationJobFluentBuilder

Constructs a fluent builder for the GetModelInvocationJob operation.

Source§

impl Client

Source

pub fn get_model_invocation_logging_configuration( &self, ) -> GetModelInvocationLoggingConfigurationFluentBuilder

Constructs a fluent builder for the GetModelInvocationLoggingConfiguration operation.

Source§

impl Client

Source

pub fn get_prompt_router(&self) -> GetPromptRouterFluentBuilder

Constructs a fluent builder for the GetPromptRouter operation.

Source§

impl Client

Source

pub fn get_provisioned_model_throughput( &self, ) -> GetProvisionedModelThroughputFluentBuilder

Constructs a fluent builder for the GetProvisionedModelThroughput operation.

Source§

impl Client

Source

pub fn get_use_case_for_model_access( &self, ) -> GetUseCaseForModelAccessFluentBuilder

Constructs a fluent builder for the GetUseCaseForModelAccess operation.

Source§

impl Client

Source

pub fn list_automated_reasoning_policies( &self, ) -> ListAutomatedReasoningPoliciesFluentBuilder

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

Source§

impl Client

Source

pub fn list_automated_reasoning_policy_build_workflows( &self, ) -> ListAutomatedReasoningPolicyBuildWorkflowsFluentBuilder

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

Source§

impl Client

Source

pub fn list_automated_reasoning_policy_test_cases( &self, ) -> ListAutomatedReasoningPolicyTestCasesFluentBuilder

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

Source§

impl Client

Source

pub fn list_automated_reasoning_policy_test_results( &self, ) -> ListAutomatedReasoningPolicyTestResultsFluentBuilder

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

Source§

impl Client

Source

pub fn list_custom_model_deployments( &self, ) -> ListCustomModelDeploymentsFluentBuilder

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

Source§

impl Client

Source

pub fn list_custom_models(&self) -> ListCustomModelsFluentBuilder

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

Source§

impl Client

Source

pub fn list_evaluation_jobs(&self) -> ListEvaluationJobsFluentBuilder

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

Source§

impl Client

Source

pub fn list_foundation_model_agreement_offers( &self, ) -> ListFoundationModelAgreementOffersFluentBuilder

Constructs a fluent builder for the ListFoundationModelAgreementOffers operation.

Source§

impl Client

Source

pub fn list_foundation_models(&self) -> ListFoundationModelsFluentBuilder

Constructs a fluent builder for the ListFoundationModels operation.

Source§

impl Client

Source

pub fn list_guardrails(&self) -> ListGuardrailsFluentBuilder

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

Source§

impl Client

Source

pub fn list_imported_models(&self) -> ListImportedModelsFluentBuilder

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

Source§

impl Client

Source

pub fn list_inference_profiles(&self) -> ListInferenceProfilesFluentBuilder

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

Source§

impl Client

Source

pub fn list_marketplace_model_endpoints( &self, ) -> ListMarketplaceModelEndpointsFluentBuilder

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

Source§

impl Client

Source

pub fn list_model_copy_jobs(&self) -> ListModelCopyJobsFluentBuilder

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

Source§

impl Client

Source

pub fn list_model_customization_jobs( &self, ) -> ListModelCustomizationJobsFluentBuilder

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

Source§

impl Client

Source

pub fn list_model_import_jobs(&self) -> ListModelImportJobsFluentBuilder

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

Source§

impl Client

Source

pub fn list_model_invocation_jobs(&self) -> ListModelInvocationJobsFluentBuilder

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

Source§

impl Client

Source

pub fn list_prompt_routers(&self) -> ListPromptRoutersFluentBuilder

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

Source§

impl Client

Source

pub fn list_provisioned_model_throughputs( &self, ) -> ListProvisionedModelThroughputsFluentBuilder

Constructs a fluent builder for the ListProvisionedModelThroughputs 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 put_model_invocation_logging_configuration( &self, ) -> PutModelInvocationLoggingConfigurationFluentBuilder

Constructs a fluent builder for the PutModelInvocationLoggingConfiguration operation.

Source§

impl Client

Source

pub fn put_use_case_for_model_access( &self, ) -> PutUseCaseForModelAccessFluentBuilder

Constructs a fluent builder for the PutUseCaseForModelAccess operation.

Source§

impl Client

Source

pub fn register_marketplace_model_endpoint( &self, ) -> RegisterMarketplaceModelEndpointFluentBuilder

Constructs a fluent builder for the RegisterMarketplaceModelEndpoint operation.

Source§

impl Client

Source

pub fn start_automated_reasoning_policy_build_workflow( &self, ) -> StartAutomatedReasoningPolicyBuildWorkflowFluentBuilder

Constructs a fluent builder for the StartAutomatedReasoningPolicyBuildWorkflow operation.

Source§

impl Client

Source

pub fn start_automated_reasoning_policy_test_workflow( &self, ) -> StartAutomatedReasoningPolicyTestWorkflowFluentBuilder

Constructs a fluent builder for the StartAutomatedReasoningPolicyTestWorkflow operation.

Source§

impl Client

Source

pub fn stop_evaluation_job(&self) -> StopEvaluationJobFluentBuilder

Constructs a fluent builder for the StopEvaluationJob operation.

Source§

impl Client

Source

pub fn stop_model_customization_job( &self, ) -> StopModelCustomizationJobFluentBuilder

Constructs a fluent builder for the StopModelCustomizationJob operation.

Source§

impl Client

Source

pub fn stop_model_invocation_job(&self) -> StopModelInvocationJobFluentBuilder

Constructs a fluent builder for the StopModelInvocationJob 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_automated_reasoning_policy( &self, ) -> UpdateAutomatedReasoningPolicyFluentBuilder

Constructs a fluent builder for the UpdateAutomatedReasoningPolicy operation.

Source§

impl Client

Source

pub fn update_automated_reasoning_policy_annotations( &self, ) -> UpdateAutomatedReasoningPolicyAnnotationsFluentBuilder

Constructs a fluent builder for the UpdateAutomatedReasoningPolicyAnnotations operation.

Source§

impl Client

Source

pub fn update_automated_reasoning_policy_test_case( &self, ) -> UpdateAutomatedReasoningPolicyTestCaseFluentBuilder

Constructs a fluent builder for the UpdateAutomatedReasoningPolicyTestCase operation.

Source§

impl Client

Source

pub fn update_guardrail(&self) -> UpdateGuardrailFluentBuilder

Constructs a fluent builder for the UpdateGuardrail operation.

Source§

impl Client

Source

pub fn update_marketplace_model_endpoint( &self, ) -> UpdateMarketplaceModelEndpointFluentBuilder

Constructs a fluent builder for the UpdateMarketplaceModelEndpoint operation.

Source§

impl Client

Source

pub fn update_provisioned_model_throughput( &self, ) -> UpdateProvisionedModelThroughputFluentBuilder

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