aws_sdk_eks::client

Struct Client

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

Client for Amazon Elastic Kubernetes Service

Client for invoking operations on Amazon Elastic Kubernetes Service. Each operation on Amazon Elastic Kubernetes Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_eks::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_eks::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 AssociateAccessPolicy operation has a Client::associate_access_policy, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

ⓘ
let result = client.associate_access_policy()
    .cluster_name("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 associate_access_policy(&self) -> AssociateAccessPolicyFluentBuilder

Constructs a fluent builder for the AssociateAccessPolicy operation.

Source§

impl Client

Source

pub fn associate_encryption_config( &self, ) -> AssociateEncryptionConfigFluentBuilder

Constructs a fluent builder for the AssociateEncryptionConfig operation.

Source§

impl Client

Source

pub fn associate_identity_provider_config( &self, ) -> AssociateIdentityProviderConfigFluentBuilder

Constructs a fluent builder for the AssociateIdentityProviderConfig operation.

Source§

impl Client

Source

pub fn create_access_entry(&self) -> CreateAccessEntryFluentBuilder

Constructs a fluent builder for the CreateAccessEntry operation.

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

      The name of your cluster.


    • principal_arn(impl Into<String>) / set_principal_arn(Option<String>):
      required: true

      The ARN of the IAM principal for the AccessEntry. You can specify one ARN for each access entry. You can’t specify the same ARN in more than one access entry. This value can’t be changed after access entry creation.

      The valid principals differ depending on the type of the access entry in the type field. For STANDARD access entries, you can use every IAM principal type. For nodes (EC2 (for EKS Auto Mode), EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX, and HYBRID_LINUX), the only valid ARN is IAM roles. You can’t use the STS session principal type with access entries because this is a temporary principal for each session and not a permanent identity that can be assigned permissions.

      IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials.


    • kubernetes_groups(impl Into<String>) / set_kubernetes_groups(Option<Vec::<String>>):
      required: false

      The value for name that you’ve specified for kind: Group as a subject in a Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn’t confirm that the value for name exists in any bindings on your cluster. You can specify one or more names.

      Kubernetes authorizes the principalArn of the access entry to access any cluster objects that you’ve specified in a Kubernetes Role or ClusterRole object that is also specified in a binding’s roleRef. For more information about creating Kubernetes RoleBinding, ClusterRoleBinding, Role, or ClusterRole objects, see Using RBAC Authorization in the Kubernetes documentation.

      If you want Amazon EKS to authorize the principalArn (instead of, or in addition to Kubernetes authorizing the principalArn), you can associate one or more access policies to the access entry using AssociateAccessPolicy. If you associate any access policies, the principalARN has all permissions assigned in the associated access policies and all permissions in any Kubernetes Role or ClusterRole objects that the group names are bound to.


    • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
      required: false

      Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don’t propagate to any other cluster or Amazon Web Services resources.


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

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.


    • username(impl Into<String>) / set_username(Option<String>):
      required: false

      The username to authenticate to Kubernetes with. We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see Creating access entries in the Amazon EKS User Guide.


    • r#type(impl Into<String>) / set_type(Option<String>):
      required: false

      The type of the new access entry. Valid values are STANDARD, FARGATE_LINUX, EC2_LINUX, EC2_WINDOWS, EC2 (for EKS Auto Mode), HYBRID_LINUX, and HYPERPOD_LINUX.

      If the principalArn is for an IAM role that’s used for self-managed Amazon EC2 nodes, specify EC2_LINUX or EC2_WINDOWS. Amazon EKS grants the necessary permissions to the node for you. If the principalArn is for any other purpose, specify STANDARD. If you don’t specify a value, Amazon EKS sets the value to STANDARD. If you have the access mode of the cluster set to API_AND_CONFIG_MAP, it’s unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the aws-auth ConfigMap for the roles. You can’t change this value once you’ve created the access entry.

      If you set the value to EC2_LINUX or EC2_WINDOWS, you can’t specify values for kubernetesGroups, or associate an AccessPolicy to the access entry.


  • On success, responds with CreateAccessEntryOutput with field(s):
    • access_entry(Option<AccessEntry>):

      An access entry allows an IAM principal (user or role) to access your cluster. Access entries can replace the need to maintain the aws-auth ConfigMap for authentication. For more information about access entries, see Access entries in the Amazon EKS User Guide.

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

impl Client

Source

pub fn create_addon(&self) -> CreateAddonFluentBuilder

Constructs a fluent builder for the CreateAddon operation.

Source§

impl Client

Source

pub fn create_cluster(&self) -> CreateClusterFluentBuilder

Constructs a fluent builder for the CreateCluster operation.

Source§

impl Client

Source

pub fn create_eks_anywhere_subscription( &self, ) -> CreateEksAnywhereSubscriptionFluentBuilder

Constructs a fluent builder for the CreateEksAnywhereSubscription operation.

Source§

impl Client

Source

pub fn create_fargate_profile(&self) -> CreateFargateProfileFluentBuilder

Constructs a fluent builder for the CreateFargateProfile operation.

Source§

impl Client

Source

pub fn create_nodegroup(&self) -> CreateNodegroupFluentBuilder

Constructs a fluent builder for the CreateNodegroup operation.

Source§

impl Client

Source

pub fn create_pod_identity_association( &self, ) -> CreatePodIdentityAssociationFluentBuilder

Constructs a fluent builder for the CreatePodIdentityAssociation operation.

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

      The name of the cluster to create the association in.


    • namespace(impl Into<String>) / set_namespace(Option<String>):
      required: true

      The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the pods that use the service account must be in this namespace.


    • service_account(impl Into<String>) / set_service_account(Option<String>):
      required: true

      The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.


    • role_arn(impl Into<String>) / set_role_arn(Option<String>):
      required: true

      The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the pods that use this service account.


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

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.


    • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
      required: false

      Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don’t propagate to any other cluster or Amazon Web Services resources.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource – 50

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length – 128 Unicode characters in UTF-8

      • Maximum value length – 256 Unicode characters in UTF-8

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case-sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.


  • On success, responds with CreatePodIdentityAssociationOutput with field(s):
    • association(Option<PodIdentityAssociation>):

      The full description of your new association.

      The description includes an ID for the association. Use the ID of the association in further actions to manage the association.

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

impl Client

Source

pub fn delete_access_entry(&self) -> DeleteAccessEntryFluentBuilder

Constructs a fluent builder for the DeleteAccessEntry operation.

Source§

impl Client

Source

pub fn delete_addon(&self) -> DeleteAddonFluentBuilder

Constructs a fluent builder for the DeleteAddon operation.

Source§

impl Client

Source

pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder

Constructs a fluent builder for the DeleteCluster operation.

Source§

impl Client

Source

pub fn delete_eks_anywhere_subscription( &self, ) -> DeleteEksAnywhereSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteEksAnywhereSubscription operation.

Source§

impl Client

Source

pub fn delete_fargate_profile(&self) -> DeleteFargateProfileFluentBuilder

Constructs a fluent builder for the DeleteFargateProfile operation.

Source§

impl Client

Source

pub fn delete_nodegroup(&self) -> DeleteNodegroupFluentBuilder

Constructs a fluent builder for the DeleteNodegroup operation.

Source§

impl Client

Source

pub fn delete_pod_identity_association( &self, ) -> DeletePodIdentityAssociationFluentBuilder

Constructs a fluent builder for the DeletePodIdentityAssociation operation.

Source§

impl Client

Source

pub fn deregister_cluster(&self) -> DeregisterClusterFluentBuilder

Constructs a fluent builder for the DeregisterCluster operation.

Source§

impl Client

Source

pub fn describe_access_entry(&self) -> DescribeAccessEntryFluentBuilder

Constructs a fluent builder for the DescribeAccessEntry operation.

Source§

impl Client

Source

pub fn describe_addon(&self) -> DescribeAddonFluentBuilder

Constructs a fluent builder for the DescribeAddon operation.

Source§

impl Client

Source

pub fn describe_addon_configuration( &self, ) -> DescribeAddonConfigurationFluentBuilder

Constructs a fluent builder for the DescribeAddonConfiguration operation.

Source§

impl Client

Source

pub fn describe_addon_versions(&self) -> DescribeAddonVersionsFluentBuilder

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

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_cluster_versions(&self) -> DescribeClusterVersionsFluentBuilder

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

Source§

impl Client

Source

pub fn describe_eks_anywhere_subscription( &self, ) -> DescribeEksAnywhereSubscriptionFluentBuilder

Constructs a fluent builder for the DescribeEksAnywhereSubscription operation.

Source§

impl Client

Source

pub fn describe_fargate_profile(&self) -> DescribeFargateProfileFluentBuilder

Constructs a fluent builder for the DescribeFargateProfile operation.

Source§

impl Client

Source

pub fn describe_identity_provider_config( &self, ) -> DescribeIdentityProviderConfigFluentBuilder

Constructs a fluent builder for the DescribeIdentityProviderConfig operation.

Source§

impl Client

Source

pub fn describe_insight(&self) -> DescribeInsightFluentBuilder

Constructs a fluent builder for the DescribeInsight operation.

Source§

impl Client

Source

pub fn describe_nodegroup(&self) -> DescribeNodegroupFluentBuilder

Constructs a fluent builder for the DescribeNodegroup operation.

Source§

impl Client

Source

pub fn describe_pod_identity_association( &self, ) -> DescribePodIdentityAssociationFluentBuilder

Constructs a fluent builder for the DescribePodIdentityAssociation operation.

Source§

impl Client

Source

pub fn describe_update(&self) -> DescribeUpdateFluentBuilder

Constructs a fluent builder for the DescribeUpdate operation.

Source§

impl Client

Source

pub fn disassociate_access_policy( &self, ) -> DisassociateAccessPolicyFluentBuilder

Constructs a fluent builder for the DisassociateAccessPolicy operation.

Source§

impl Client

Source

pub fn disassociate_identity_provider_config( &self, ) -> DisassociateIdentityProviderConfigFluentBuilder

Constructs a fluent builder for the DisassociateIdentityProviderConfig operation.

Source§

impl Client

Source

pub fn list_access_entries(&self) -> ListAccessEntriesFluentBuilder

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

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

      The name of your cluster.


    • associated_policy_arn(impl Into<String>) / set_associated_policy_arn(Option<String>):
      required: false

      The ARN of an AccessPolicy. When you specify an access policy ARN, only the access entries associated to that access policy are returned. For a list of available policy ARNs, use ListAccessPolicies.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and a nextToken value, if applicable, are returned.


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

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.


  • On success, responds with ListAccessEntriesOutput with field(s):
    • access_entries(Option<Vec::<String>>):

      The list of access entries that exist for the cluster.

    • next_token(Option<String>):

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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

impl Client

Source

pub fn list_access_policies(&self) -> ListAccessPoliciesFluentBuilder

Constructs a fluent builder for the ListAccessPolicies 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, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and a nextToken value, if applicable, are returned.


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

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.


  • On success, responds with ListAccessPoliciesOutput with field(s):
    • access_policies(Option<Vec::<AccessPolicy>>):

      The list of available access policies. You can’t view the contents of an access policy using the API. To view the contents, see Access policy permissions in the Amazon EKS User Guide.

    • next_token(Option<String>):

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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

impl Client

Source

pub fn list_addons(&self) -> ListAddonsFluentBuilder

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

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

      The name of your cluster.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and a nextToken value, if applicable, are returned.


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

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.


  • On success, responds with ListAddonsOutput with field(s):
    • addons(Option<Vec::<String>>):

      A list of installed add-ons.

    • next_token(Option<String>):

      The nextToken value to include in a future ListAddons request. When the results of a ListAddons request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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

impl Client

Source

pub fn list_associated_access_policies( &self, ) -> ListAssociatedAccessPoliciesFluentBuilder

Constructs a fluent builder for the ListAssociatedAccessPolicies 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().

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

      The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and a nextToken value, if applicable, are returned.


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

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.


    • include(impl Into<String>) / set_include(Option<Vec::<String>>):
      required: false

      Indicates whether external clusters are included in the returned list. Use ‘all’ to return https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.htmlconnected clusters, or blank to return only Amazon EKS clusters. ‘all’ must be in lowercase otherwise an error occurs.


  • On success, responds with ListClustersOutput with field(s):
    • clusters(Option<Vec::<String>>):

      A list of all of the clusters for your account in the specified Amazon Web Services Region .

    • next_token(Option<String>):

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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

impl Client

Source

pub fn list_eks_anywhere_subscriptions( &self, ) -> ListEksAnywhereSubscriptionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_fargate_profiles(&self) -> ListFargateProfilesFluentBuilder

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

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

      The name of your cluster.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and a nextToken value, if applicable, are returned.


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

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.


  • On success, responds with ListFargateProfilesOutput with field(s):
    • fargate_profile_names(Option<Vec::<String>>):

      A list of all of the Fargate profiles associated with the specified cluster.

    • next_token(Option<String>):

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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

impl Client

Source

pub fn list_identity_provider_configs( &self, ) -> ListIdentityProviderConfigsFluentBuilder

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

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

      The name of your cluster.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and a nextToken value, if applicable, are returned.


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

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.


  • On success, responds with ListIdentityProviderConfigsOutput with field(s):
    • identity_provider_configs(Option<Vec::<IdentityProviderConfig>>):

      The identity provider configurations for the cluster.

    • next_token(Option<String>):

      The nextToken value to include in a future ListIdentityProviderConfigsResponse request. When the results of a ListIdentityProviderConfigsResponse request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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

impl Client

Source

pub fn list_insights(&self) -> ListInsightsFluentBuilder

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

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

      The name of the Amazon EKS cluster associated with the insights.


    • filter(InsightsFilter) / set_filter(Option<InsightsFilter>):
      required: false

      The criteria to filter your list of insights for your cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of identity provider configurations returned by ListInsights in paginated output. When you use this parameter, ListInsights returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListInsights request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListInsights returns up to 100 results and a nextToken value, if applicable.


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

      The nextToken value returned from a previous paginated ListInsights request. When the results of a ListInsights request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.


  • On success, responds with ListInsightsOutput with field(s):
    • insights(Option<Vec::<InsightSummary>>):

      The returned list of insights.

    • next_token(Option<String>):

      The nextToken value to include in a future ListInsights request. When the results of a ListInsights request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

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

impl Client

Source

pub fn list_nodegroups(&self) -> ListNodegroupsFluentBuilder

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

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

      The name of your cluster.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and a nextToken value, if applicable, are returned.


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

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.


  • On success, responds with ListNodegroupsOutput with field(s):
    • nodegroups(Option<Vec::<String>>):

      A list of all of the node groups associated with the specified cluster.

    • next_token(Option<String>):

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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

impl Client

Source

pub fn list_pod_identity_associations( &self, ) -> ListPodIdentityAssociationsFluentBuilder

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

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

      The name of the cluster that the associations are in.


    • namespace(impl Into<String>) / set_namespace(Option<String>):
      required: false

      The name of the Kubernetes namespace inside the cluster that the associations are in.


    • service_account(impl Into<String>) / set_service_account(Option<String>):
      required: false

      The name of the Kubernetes service account that the associations use.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of EKS Pod Identity association results returned by ListPodIdentityAssociations in paginated output. When you use this parameter, ListPodIdentityAssociations returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListPodIdentityAssociations request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListPodIdentityAssociations returns up to 100 results and a nextToken value if applicable.


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

      The nextToken value returned from a previous paginated ListUpdates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.


  • On success, responds with ListPodIdentityAssociationsOutput with field(s):
    • associations(Option<Vec::<PodIdentityAssociationSummary>>):

      The list of summarized descriptions of the associations that are in the cluster and match any filters that you provided.

      Each summary is simplified by removing these fields compared to the full PodIdentityAssociation :

      • The IAM role: roleArn

      • The timestamp that the association was created at: createdAt

      • The most recent timestamp that the association was modified at:. modifiedAt

      • The tags on the association: tags

    • next_token(Option<String>):

      The nextToken value to include in a future ListPodIdentityAssociations request. When the results of a ListPodIdentityAssociations request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

Source§

impl Client

Source

pub fn list_updates(&self) -> ListUpdatesFluentBuilder

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

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

      The name of the Amazon EKS cluster to list updates for.


    • nodegroup_name(impl Into<String>) / set_nodegroup_name(Option<String>):
      required: false

      The name of the Amazon EKS managed node group to list updates for.


    • addon_name(impl Into<String>) / set_addon_name(Option<String>):
      required: false

      The names of the installed add-ons that have available updates.


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

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.


    • max_results(i32) / set_max_results(Option<i32>):
      required: false

      The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, 100 results and a nextToken value, if applicable, are returned.


  • On success, responds with ListUpdatesOutput with field(s):
    • update_ids(Option<Vec::<String>>):

      A list of all the updates for the specified cluster and Region.

    • next_token(Option<String>):

      The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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

impl Client

Source

pub fn register_cluster(&self) -> RegisterClusterFluentBuilder

Constructs a fluent builder for the RegisterCluster 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_access_entry(&self) -> UpdateAccessEntryFluentBuilder

Constructs a fluent builder for the UpdateAccessEntry operation.

Source§

impl Client

Source

pub fn update_addon(&self) -> UpdateAddonFluentBuilder

Constructs a fluent builder for the UpdateAddon operation.

Source§

impl Client

Source

pub fn update_cluster_config(&self) -> UpdateClusterConfigFluentBuilder

Constructs a fluent builder for the UpdateClusterConfig operation.

Source§

impl Client

Source

pub fn update_cluster_version(&self) -> UpdateClusterVersionFluentBuilder

Constructs a fluent builder for the UpdateClusterVersion operation.

Source§

impl Client

Source

pub fn update_eks_anywhere_subscription( &self, ) -> UpdateEksAnywhereSubscriptionFluentBuilder

Constructs a fluent builder for the UpdateEksAnywhereSubscription operation.

Source§

impl Client

Source

pub fn update_nodegroup_config(&self) -> UpdateNodegroupConfigFluentBuilder

Constructs a fluent builder for the UpdateNodegroupConfig operation.

Source§

impl Client

Source

pub fn update_nodegroup_version(&self) -> UpdateNodegroupVersionFluentBuilder

Constructs a fluent builder for the UpdateNodegroupVersion operation.

Source§

impl Client

Source

pub fn update_pod_identity_association( &self, ) -> UpdatePodIdentityAssociationFluentBuilder

Constructs a fluent builder for the UpdatePodIdentityAssociation 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 copy 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
Source§

impl Waiters for Client

Source§

fn wait_until_addon_active(&self) -> AddonActiveFluentBuilder

Wait for addon_active
Source§

fn wait_until_addon_deleted(&self) -> AddonDeletedFluentBuilder

Wait for addon_deleted
Source§

fn wait_until_cluster_active(&self) -> ClusterActiveFluentBuilder

Wait for cluster_active
Source§

fn wait_until_cluster_deleted(&self) -> ClusterDeletedFluentBuilder

Wait for cluster_deleted
Source§

fn wait_until_fargate_profile_active(&self) -> FargateProfileActiveFluentBuilder

Wait for fargate_profile_active
Source§

fn wait_until_fargate_profile_deleted( &self, ) -> FargateProfileDeletedFluentBuilder

Wait for fargate_profile_deleted
Source§

fn wait_until_nodegroup_active(&self) -> NodegroupActiveFluentBuilder

Wait for nodegroup_active
Source§

fn wait_until_nodegroup_deleted(&self) -> NodegroupDeletedFluentBuilder

Wait for nodegroup_deleted

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,