Struct Client

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

Client for Amazon EMR

Client for invoking operations on Amazon EMR. Each operation on Amazon EMR 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_emr::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_emr::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 AddInstanceFleet operation has a Client::add_instance_fleet, 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.add_instance_fleet()
    .cluster_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

§Waiters

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

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

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

Implementations§

Source§

impl Client

Source

pub fn add_instance_fleet(&self) -> AddInstanceFleetFluentBuilder

Constructs a fluent builder for the AddInstanceFleet operation.

Source§

impl Client

Source

pub fn add_instance_groups(&self) -> AddInstanceGroupsFluentBuilder

Constructs a fluent builder for the AddInstanceGroups operation.

Source§

impl Client

Source

pub fn add_job_flow_steps(&self) -> AddJobFlowStepsFluentBuilder

Constructs a fluent builder for the AddJobFlowSteps operation.

Source§

impl Client

Source

pub fn add_tags(&self) -> AddTagsFluentBuilder

Constructs a fluent builder for the AddTags operation.

Source§

impl Client

Source

pub fn cancel_steps(&self) -> CancelStepsFluentBuilder

Constructs a fluent builder for the CancelSteps operation.

Source§

impl Client

Source

pub fn create_persistent_app_ui(&self) -> CreatePersistentAppUIFluentBuilder

Constructs a fluent builder for the CreatePersistentAppUI operation.

Source§

impl Client

Source

pub fn create_security_configuration( &self, ) -> CreateSecurityConfigurationFluentBuilder

Constructs a fluent builder for the CreateSecurityConfiguration operation.

Source§

impl Client

Source

pub fn create_studio(&self) -> CreateStudioFluentBuilder

Constructs a fluent builder for the CreateStudio operation.

Source§

impl Client

Source

pub fn create_studio_session_mapping( &self, ) -> CreateStudioSessionMappingFluentBuilder

Constructs a fluent builder for the CreateStudioSessionMapping operation.

Source§

impl Client

Source

pub fn delete_security_configuration( &self, ) -> DeleteSecurityConfigurationFluentBuilder

Constructs a fluent builder for the DeleteSecurityConfiguration operation.

Source§

impl Client

Source

pub fn delete_studio(&self) -> DeleteStudioFluentBuilder

Constructs a fluent builder for the DeleteStudio operation.

Source§

impl Client

Source

pub fn delete_studio_session_mapping( &self, ) -> DeleteStudioSessionMappingFluentBuilder

Constructs a fluent builder for the DeleteStudioSessionMapping operation.

Source§

impl Client

Source

pub fn describe_cluster(&self) -> DescribeClusterFluentBuilder

Constructs a fluent builder for the DescribeCluster operation.

Source§

impl Client

Source

pub fn describe_job_flows(&self) -> DescribeJobFlowsFluentBuilder

👎Deprecated

Constructs a fluent builder for the DescribeJobFlows operation.

Source§

impl Client

Source

pub fn describe_notebook_execution( &self, ) -> DescribeNotebookExecutionFluentBuilder

Constructs a fluent builder for the DescribeNotebookExecution operation.

Source§

impl Client

Source

pub fn describe_persistent_app_ui(&self) -> DescribePersistentAppUIFluentBuilder

Constructs a fluent builder for the DescribePersistentAppUI operation.

Source§

impl Client

Source

pub fn describe_release_label(&self) -> DescribeReleaseLabelFluentBuilder

Constructs a fluent builder for the DescribeReleaseLabel operation.

Source§

impl Client

Source

pub fn describe_security_configuration( &self, ) -> DescribeSecurityConfigurationFluentBuilder

Constructs a fluent builder for the DescribeSecurityConfiguration operation.

Source§

impl Client

Source

pub fn describe_step(&self) -> DescribeStepFluentBuilder

Constructs a fluent builder for the DescribeStep operation.

Source§

impl Client

Source

pub fn describe_studio(&self) -> DescribeStudioFluentBuilder

Constructs a fluent builder for the DescribeStudio operation.

Source§

impl Client

Source

pub fn get_auto_termination_policy( &self, ) -> GetAutoTerminationPolicyFluentBuilder

Constructs a fluent builder for the GetAutoTerminationPolicy operation.

Source§

impl Client

Source

pub fn get_block_public_access_configuration( &self, ) -> GetBlockPublicAccessConfigurationFluentBuilder

Constructs a fluent builder for the GetBlockPublicAccessConfiguration operation.

  • The fluent builder takes no input, just send it.
  • On success, responds with GetBlockPublicAccessConfigurationOutput with field(s):
    • block_public_access_configuration(Option<BlockPublicAccessConfiguration>):

      A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.

      For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an Amazon EMR cluster in a Region before this date, block public access is enabled by default in that Region.

    • block_public_access_configuration_metadata(Option<BlockPublicAccessConfigurationMetadata>):

      Properties that describe the Amazon Web Services principal that created the BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.

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

impl Client

Source

pub fn get_cluster_session_credentials( &self, ) -> GetClusterSessionCredentialsFluentBuilder

Constructs a fluent builder for the GetClusterSessionCredentials operation.

Source§

impl Client

Source

pub fn get_managed_scaling_policy(&self) -> GetManagedScalingPolicyFluentBuilder

Constructs a fluent builder for the GetManagedScalingPolicy operation.

Source§

impl Client

Source

pub fn get_on_cluster_app_ui_presigned_url( &self, ) -> GetOnClusterAppUIPresignedURLFluentBuilder

Constructs a fluent builder for the GetOnClusterAppUIPresignedURL operation.

Source§

impl Client

Source

pub fn get_persistent_app_ui_presigned_url( &self, ) -> GetPersistentAppUIPresignedURLFluentBuilder

Constructs a fluent builder for the GetPersistentAppUIPresignedURL operation.

Source§

impl Client

Source

pub fn get_studio_session_mapping(&self) -> GetStudioSessionMappingFluentBuilder

Constructs a fluent builder for the GetStudioSessionMapping operation.

Source§

impl Client

Source

pub fn list_bootstrap_actions(&self) -> ListBootstrapActionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_clusters(&self) -> ListClustersFluentBuilder

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

Source§

impl Client

Source

pub fn list_instance_fleets(&self) -> ListInstanceFleetsFluentBuilder

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

Source§

impl Client

Source

pub fn list_instance_groups(&self) -> ListInstanceGroupsFluentBuilder

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

Source§

impl Client

Source

pub fn list_instances(&self) -> ListInstancesFluentBuilder

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

Source§

impl Client

Source

pub fn list_notebook_executions(&self) -> ListNotebookExecutionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_release_labels(&self) -> ListReleaseLabelsFluentBuilder

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

Source§

impl Client

Source

pub fn list_security_configurations( &self, ) -> ListSecurityConfigurationsFluentBuilder

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

Source§

impl Client

Source

pub fn list_steps(&self) -> ListStepsFluentBuilder

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

Source§

impl Client

Source

pub fn list_studio_session_mappings( &self, ) -> ListStudioSessionMappingsFluentBuilder

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

Source§

impl Client

Source

pub fn list_studios(&self) -> ListStudiosFluentBuilder

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

Source§

impl Client

Source

pub fn list_supported_instance_types( &self, ) -> ListSupportedInstanceTypesFluentBuilder

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

Source§

impl Client

Source

pub fn modify_cluster(&self) -> ModifyClusterFluentBuilder

Constructs a fluent builder for the ModifyCluster operation.

Source§

impl Client

Source

pub fn modify_instance_fleet(&self) -> ModifyInstanceFleetFluentBuilder

Constructs a fluent builder for the ModifyInstanceFleet operation.

Source§

impl Client

Source

pub fn modify_instance_groups(&self) -> ModifyInstanceGroupsFluentBuilder

Constructs a fluent builder for the ModifyInstanceGroups operation.

Source§

impl Client

Source

pub fn put_auto_scaling_policy(&self) -> PutAutoScalingPolicyFluentBuilder

Constructs a fluent builder for the PutAutoScalingPolicy operation.

Source§

impl Client

Source

pub fn put_auto_termination_policy( &self, ) -> PutAutoTerminationPolicyFluentBuilder

Constructs a fluent builder for the PutAutoTerminationPolicy operation.

Source§

impl Client

Source

pub fn put_block_public_access_configuration( &self, ) -> PutBlockPublicAccessConfigurationFluentBuilder

Constructs a fluent builder for the PutBlockPublicAccessConfiguration operation.

  • The fluent builder is configurable:
    • block_public_access_configuration(BlockPublicAccessConfiguration) / set_block_public_access_configuration(Option<BlockPublicAccessConfiguration>):
      required: true

      A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating BlockPublicSecurityGroupRules to remove the exception.

      For accounts that created clusters in a Region before November 25, 2019, block public access is disabled by default in that Region. To use this feature, you must manually enable and configure it. For accounts that did not create an Amazon EMR cluster in a Region before this date, block public access is enabled by default in that Region.


  • On success, responds with PutBlockPublicAccessConfigurationOutput
  • On failure, responds with SdkError<PutBlockPublicAccessConfigurationError>
Source§

impl Client

Source

pub fn put_managed_scaling_policy(&self) -> PutManagedScalingPolicyFluentBuilder

Constructs a fluent builder for the PutManagedScalingPolicy operation.

Source§

impl Client

Source

pub fn remove_auto_scaling_policy(&self) -> RemoveAutoScalingPolicyFluentBuilder

Constructs a fluent builder for the RemoveAutoScalingPolicy operation.

Source§

impl Client

Source

pub fn remove_auto_termination_policy( &self, ) -> RemoveAutoTerminationPolicyFluentBuilder

Constructs a fluent builder for the RemoveAutoTerminationPolicy operation.

Source§

impl Client

Source

pub fn remove_managed_scaling_policy( &self, ) -> RemoveManagedScalingPolicyFluentBuilder

Constructs a fluent builder for the RemoveManagedScalingPolicy operation.

Source§

impl Client

Source

pub fn remove_tags(&self) -> RemoveTagsFluentBuilder

Constructs a fluent builder for the RemoveTags operation.

Source§

impl Client

Source

pub fn run_job_flow(&self) -> RunJobFlowFluentBuilder

Constructs a fluent builder for the RunJobFlow operation.

Source§

impl Client

Source

pub fn set_keep_job_flow_alive_when_no_steps( &self, ) -> SetKeepJobFlowAliveWhenNoStepsFluentBuilder

Constructs a fluent builder for the SetKeepJobFlowAliveWhenNoSteps operation.

Source§

impl Client

Source

pub fn set_termination_protection( &self, ) -> SetTerminationProtectionFluentBuilder

Constructs a fluent builder for the SetTerminationProtection operation.

Source§

impl Client

Source

pub fn set_unhealthy_node_replacement( &self, ) -> SetUnhealthyNodeReplacementFluentBuilder

Constructs a fluent builder for the SetUnhealthyNodeReplacement operation.

Source§

impl Client

Source

pub fn set_visible_to_all_users(&self) -> SetVisibleToAllUsersFluentBuilder

Constructs a fluent builder for the SetVisibleToAllUsers operation.

Source§

impl Client

Source

pub fn start_notebook_execution(&self) -> StartNotebookExecutionFluentBuilder

Constructs a fluent builder for the StartNotebookExecution operation.

Source§

impl Client

Source

pub fn stop_notebook_execution(&self) -> StopNotebookExecutionFluentBuilder

Constructs a fluent builder for the StopNotebookExecution operation.

Source§

impl Client

Source

pub fn terminate_job_flows(&self) -> TerminateJobFlowsFluentBuilder

Constructs a fluent builder for the TerminateJobFlows operation.

Source§

impl Client

Source

pub fn update_studio(&self) -> UpdateStudioFluentBuilder

Constructs a fluent builder for the UpdateStudio operation.

Source§

impl Client

Source

pub fn update_studio_session_mapping( &self, ) -> UpdateStudioSessionMappingFluentBuilder

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

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Waiters for Client

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,