Skip to main content

Client

Struct Client 

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

Client for Amazon Bedrock AgentCore

Client for invoking operations on Amazon Bedrock AgentCore. Each operation on Amazon Bedrock AgentCore 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_bedrockagentcore::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_bedrockagentcore::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 BatchCreateMemoryRecords operation has a Client::batch_create_memory_records, 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_create_memory_records()
    .memory_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 batch_create_memory_records( &self, ) -> BatchCreateMemoryRecordsFluentBuilder

Constructs a fluent builder for the BatchCreateMemoryRecords operation.

Source§

impl Client

Source

pub fn batch_delete_memory_records( &self, ) -> BatchDeleteMemoryRecordsFluentBuilder

Constructs a fluent builder for the BatchDeleteMemoryRecords operation.

Source§

impl Client

Source

pub fn batch_update_memory_records( &self, ) -> BatchUpdateMemoryRecordsFluentBuilder

Constructs a fluent builder for the BatchUpdateMemoryRecords operation.

Source§

impl Client

Source

pub fn complete_resource_token_auth( &self, ) -> CompleteResourceTokenAuthFluentBuilder

Constructs a fluent builder for the CompleteResourceTokenAuth operation.

Source§

impl Client

Source

pub fn create_ab_test(&self) -> CreateABTestFluentBuilder

Constructs a fluent builder for the CreateABTest operation.

Source§

impl Client

Source

pub fn create_event(&self) -> CreateEventFluentBuilder

Constructs a fluent builder for the CreateEvent operation.

Source§

impl Client

Source

pub fn create_payment_instrument(&self) -> CreatePaymentInstrumentFluentBuilder

Constructs a fluent builder for the CreatePaymentInstrument operation.

Source§

impl Client

Source

pub fn create_payment_session(&self) -> CreatePaymentSessionFluentBuilder

Constructs a fluent builder for the CreatePaymentSession operation.

Source§

impl Client

Source

pub fn delete_ab_test(&self) -> DeleteABTestFluentBuilder

Constructs a fluent builder for the DeleteABTest operation.

Source§

impl Client

Source

pub fn delete_batch_evaluation(&self) -> DeleteBatchEvaluationFluentBuilder

Constructs a fluent builder for the DeleteBatchEvaluation operation.

Source§

impl Client

Source

pub fn delete_event(&self) -> DeleteEventFluentBuilder

Constructs a fluent builder for the DeleteEvent operation.

Source§

impl Client

Source

pub fn delete_memory_record(&self) -> DeleteMemoryRecordFluentBuilder

Constructs a fluent builder for the DeleteMemoryRecord operation.

Source§

impl Client

Source

pub fn delete_payment_instrument(&self) -> DeletePaymentInstrumentFluentBuilder

Constructs a fluent builder for the DeletePaymentInstrument operation.

Source§

impl Client

Source

pub fn delete_payment_session(&self) -> DeletePaymentSessionFluentBuilder

Constructs a fluent builder for the DeletePaymentSession operation.

Source§

impl Client

Source

pub fn delete_recommendation(&self) -> DeleteRecommendationFluentBuilder

Constructs a fluent builder for the DeleteRecommendation operation.

Source§

impl Client

Source

pub fn evaluate(&self) -> EvaluateFluentBuilder

Constructs a fluent builder for the Evaluate operation.

Source§

impl Client

Source

pub fn get_ab_test(&self) -> GetABTestFluentBuilder

Constructs a fluent builder for the GetABTest operation.

Source§

impl Client

Source

pub fn get_agent_card(&self) -> GetAgentCardFluentBuilder

Constructs a fluent builder for the GetAgentCard operation.

Source§

impl Client

Source

pub fn get_batch_evaluation(&self) -> GetBatchEvaluationFluentBuilder

Constructs a fluent builder for the GetBatchEvaluation operation.

Source§

impl Client

Source

pub fn get_browser_session(&self) -> GetBrowserSessionFluentBuilder

Constructs a fluent builder for the GetBrowserSession operation.

Source§

impl Client

Source

pub fn get_code_interpreter_session( &self, ) -> GetCodeInterpreterSessionFluentBuilder

Constructs a fluent builder for the GetCodeInterpreterSession operation.

Source§

impl Client

Source

pub fn get_event(&self) -> GetEventFluentBuilder

Constructs a fluent builder for the GetEvent operation.

Source§

impl Client

Source

pub fn get_memory_record(&self) -> GetMemoryRecordFluentBuilder

Constructs a fluent builder for the GetMemoryRecord operation.

Source§

impl Client

Source

pub fn get_payment_instrument(&self) -> GetPaymentInstrumentFluentBuilder

Constructs a fluent builder for the GetPaymentInstrument operation.

Source§

impl Client

Source

pub fn get_payment_instrument_balance( &self, ) -> GetPaymentInstrumentBalanceFluentBuilder

Constructs a fluent builder for the GetPaymentInstrumentBalance operation.

Source§

impl Client

Source

pub fn get_payment_session(&self) -> GetPaymentSessionFluentBuilder

Constructs a fluent builder for the GetPaymentSession operation.

Source§

impl Client

Source

pub fn get_recommendation(&self) -> GetRecommendationFluentBuilder

Constructs a fluent builder for the GetRecommendation operation.

Source§

impl Client

Source

pub fn get_resource_api_key(&self) -> GetResourceApiKeyFluentBuilder

Constructs a fluent builder for the GetResourceApiKey operation.

Source§

impl Client

Source

pub fn get_resource_oauth2_token(&self) -> GetResourceOauth2TokenFluentBuilder

Constructs a fluent builder for the GetResourceOauth2Token operation.

Source§

impl Client

Source

pub fn get_resource_payment_token(&self) -> GetResourcePaymentTokenFluentBuilder

Constructs a fluent builder for the GetResourcePaymentToken operation.

Source§

impl Client

Source

pub fn get_workload_access_token(&self) -> GetWorkloadAccessTokenFluentBuilder

Constructs a fluent builder for the GetWorkloadAccessToken operation.

Source§

impl Client

Source

pub fn get_workload_access_token_for_jwt( &self, ) -> GetWorkloadAccessTokenForJWTFluentBuilder

Constructs a fluent builder for the GetWorkloadAccessTokenForJWT operation.

Source§

impl Client

Source

pub fn get_workload_access_token_for_user_id( &self, ) -> GetWorkloadAccessTokenForUserIdFluentBuilder

Constructs a fluent builder for the GetWorkloadAccessTokenForUserId operation.

Source§

impl Client

Source

pub fn invoke_agent_runtime(&self) -> InvokeAgentRuntimeFluentBuilder

Constructs a fluent builder for the InvokeAgentRuntime operation.

Source§

impl Client

Source

pub fn invoke_agent_runtime_command( &self, ) -> InvokeAgentRuntimeCommandFluentBuilder

Constructs a fluent builder for the InvokeAgentRuntimeCommand operation.

Source§

impl Client

Source

pub fn invoke_browser(&self) -> InvokeBrowserFluentBuilder

Constructs a fluent builder for the InvokeBrowser operation.

Source§

impl Client

Source

pub fn invoke_code_interpreter(&self) -> InvokeCodeInterpreterFluentBuilder

Constructs a fluent builder for the InvokeCodeInterpreter operation.

Source§

impl Client

Source

pub fn invoke_harness(&self) -> InvokeHarnessFluentBuilder

Constructs a fluent builder for the InvokeHarness operation.

Source§

impl Client

Source

pub fn list_ab_tests(&self) -> ListABTestsFluentBuilder

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

  • The fluent builder is configurable:
    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.


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

      If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.


  • On success, responds with ListAbTestsOutput with field(s):
    • ab_tests(Vec::<AbTestSummary>):

      The list of A/B test summaries.

    • next_token(Option<String>):

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

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

impl Client

Source

pub fn list_actors(&self) -> ListActorsFluentBuilder

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

Source§

impl Client

Source

pub fn list_batch_evaluations(&self) -> ListBatchEvaluationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_browser_sessions(&self) -> ListBrowserSessionsFluentBuilder

Constructs a fluent builder for the ListBrowserSessions operation.

Source§

impl Client

Source

pub fn list_code_interpreter_sessions( &self, ) -> ListCodeInterpreterSessionsFluentBuilder

Constructs a fluent builder for the ListCodeInterpreterSessions operation.

Source§

impl Client

Source

pub fn list_events(&self) -> ListEventsFluentBuilder

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

Source§

impl Client

Source

pub fn list_memory_extraction_jobs( &self, ) -> ListMemoryExtractionJobsFluentBuilder

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

Source§

impl Client

Source

pub fn list_memory_records(&self) -> ListMemoryRecordsFluentBuilder

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

Source§

impl Client

Source

pub fn list_payment_instruments(&self) -> ListPaymentInstrumentsFluentBuilder

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

Source§

impl Client

Source

pub fn list_payment_sessions(&self) -> ListPaymentSessionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_recommendations(&self) -> ListRecommendationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_sessions(&self) -> ListSessionsFluentBuilder

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

Source§

impl Client

Source

pub fn process_payment(&self) -> ProcessPaymentFluentBuilder

Constructs a fluent builder for the ProcessPayment operation.

Source§

impl Client

Source

pub fn retrieve_memory_records(&self) -> RetrieveMemoryRecordsFluentBuilder

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

Source§

impl Client

Source

pub fn save_browser_session_profile( &self, ) -> SaveBrowserSessionProfileFluentBuilder

Constructs a fluent builder for the SaveBrowserSessionProfile operation.

Source§

impl Client

Source

pub fn search_registry_records(&self) -> SearchRegistryRecordsFluentBuilder

Constructs a fluent builder for the SearchRegistryRecords operation.

Source§

impl Client

Source

pub fn start_batch_evaluation(&self) -> StartBatchEvaluationFluentBuilder

Constructs a fluent builder for the StartBatchEvaluation operation.

Source§

impl Client

Source

pub fn start_browser_session(&self) -> StartBrowserSessionFluentBuilder

Constructs a fluent builder for the StartBrowserSession operation.

Source§

impl Client

Source

pub fn start_code_interpreter_session( &self, ) -> StartCodeInterpreterSessionFluentBuilder

Constructs a fluent builder for the StartCodeInterpreterSession operation.

Source§

impl Client

Source

pub fn start_memory_extraction_job( &self, ) -> StartMemoryExtractionJobFluentBuilder

Constructs a fluent builder for the StartMemoryExtractionJob operation.

Source§

impl Client

Source

pub fn start_recommendation(&self) -> StartRecommendationFluentBuilder

Constructs a fluent builder for the StartRecommendation operation.

Source§

impl Client

Source

pub fn stop_batch_evaluation(&self) -> StopBatchEvaluationFluentBuilder

Constructs a fluent builder for the StopBatchEvaluation operation.

Source§

impl Client

Source

pub fn stop_browser_session(&self) -> StopBrowserSessionFluentBuilder

Constructs a fluent builder for the StopBrowserSession operation.

Source§

impl Client

Source

pub fn stop_code_interpreter_session( &self, ) -> StopCodeInterpreterSessionFluentBuilder

Constructs a fluent builder for the StopCodeInterpreterSession operation.

Source§

impl Client

Source

pub fn stop_runtime_session(&self) -> StopRuntimeSessionFluentBuilder

Constructs a fluent builder for the StopRuntimeSession operation.

Source§

impl Client

Source

pub fn update_ab_test(&self) -> UpdateABTestFluentBuilder

Constructs a fluent builder for the UpdateABTest operation.

Source§

impl Client

Source

pub fn update_browser_stream(&self) -> UpdateBrowserStreamFluentBuilder

Constructs a fluent builder for the UpdateBrowserStream 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 (const: unstable) · 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§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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