aws_sdk_ecr::client

Struct Client

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

Client for Amazon Elastic Container Registry

Client for invoking operations on Amazon Elastic Container Registry. Each operation on Amazon Elastic Container Registry 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_ecr::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_ecr::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 BatchCheckLayerAvailability operation has a Client::batch_check_layer_availability, 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_check_layer_availability()
    .registry_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 batch_check_layer_availability( &self, ) -> BatchCheckLayerAvailabilityFluentBuilder

Constructs a fluent builder for the BatchCheckLayerAvailability operation.

Source§

impl Client

Source

pub fn batch_delete_image(&self) -> BatchDeleteImageFluentBuilder

Constructs a fluent builder for the BatchDeleteImage operation.

Source§

impl Client

Source

pub fn batch_get_image(&self) -> BatchGetImageFluentBuilder

Constructs a fluent builder for the BatchGetImage operation.

Source§

impl Client

Source

pub fn batch_get_repository_scanning_configuration( &self, ) -> BatchGetRepositoryScanningConfigurationFluentBuilder

Constructs a fluent builder for the BatchGetRepositoryScanningConfiguration operation.

Source§

impl Client

Source

pub fn complete_layer_upload(&self) -> CompleteLayerUploadFluentBuilder

Constructs a fluent builder for the CompleteLayerUpload operation.

Source§

impl Client

Source

pub fn create_pull_through_cache_rule( &self, ) -> CreatePullThroughCacheRuleFluentBuilder

Constructs a fluent builder for the CreatePullThroughCacheRule operation.

Source§

impl Client

Source

pub fn create_repository(&self) -> CreateRepositoryFluentBuilder

Constructs a fluent builder for the CreateRepository operation.

Source§

impl Client

Source

pub fn create_repository_creation_template( &self, ) -> CreateRepositoryCreationTemplateFluentBuilder

Constructs a fluent builder for the CreateRepositoryCreationTemplate operation.

Source§

impl Client

Source

pub fn delete_lifecycle_policy(&self) -> DeleteLifecyclePolicyFluentBuilder

Constructs a fluent builder for the DeleteLifecyclePolicy operation.

Source§

impl Client

Source

pub fn delete_pull_through_cache_rule( &self, ) -> DeletePullThroughCacheRuleFluentBuilder

Constructs a fluent builder for the DeletePullThroughCacheRule operation.

Source§

impl Client

Source

pub fn delete_registry_policy(&self) -> DeleteRegistryPolicyFluentBuilder

Constructs a fluent builder for the DeleteRegistryPolicy operation.

Source§

impl Client

Source

pub fn delete_repository(&self) -> DeleteRepositoryFluentBuilder

Constructs a fluent builder for the DeleteRepository operation.

Source§

impl Client

Source

pub fn delete_repository_creation_template( &self, ) -> DeleteRepositoryCreationTemplateFluentBuilder

Constructs a fluent builder for the DeleteRepositoryCreationTemplate operation.

Source§

impl Client

Source

pub fn delete_repository_policy(&self) -> DeleteRepositoryPolicyFluentBuilder

Constructs a fluent builder for the DeleteRepositoryPolicy operation.

Source§

impl Client

Source

pub fn describe_image_replication_status( &self, ) -> DescribeImageReplicationStatusFluentBuilder

Constructs a fluent builder for the DescribeImageReplicationStatus operation.

Source§

impl Client

Source

pub fn describe_image_scan_findings( &self, ) -> DescribeImageScanFindingsFluentBuilder

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

Source§

impl Client

Source

pub fn describe_images(&self) -> DescribeImagesFluentBuilder

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

Source§

impl Client

Source

pub fn describe_pull_through_cache_rules( &self, ) -> DescribePullThroughCacheRulesFluentBuilder

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

  • The fluent builder is configurable:
    • registry_id(impl Into<String>) / set_registry_id(Option<String>):
      required: false

      The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If you do not specify a registry, the default registry is assumed.


    • ecr_repository_prefixes(impl Into<String>) / set_ecr_repository_prefixes(Option<Vec::<String>>):
      required: false

      The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository prefix value is specified, all pull through cache rules are returned.


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

      The nextToken value returned from a previous paginated DescribePullThroughCacheRulesRequest 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.


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

      The maximum number of pull through cache rules returned by DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribePullThroughCacheRulesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value, if applicable.


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

impl Client

Source

pub fn describe_registry(&self) -> DescribeRegistryFluentBuilder

Constructs a fluent builder for the DescribeRegistry operation.

Source§

impl Client

Source

pub fn describe_repositories(&self) -> DescribeRepositoriesFluentBuilder

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

  • The fluent builder is configurable:
    • registry_id(impl Into<String>) / set_registry_id(Option<String>):
      required: false

      The Amazon Web Services account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.


    • repository_names(impl Into<String>) / set_repository_names(Option<Vec::<String>>):
      required: false

      A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.


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

      The nextToken value returned from a previous paginated DescribeRepositories 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 option cannot be used when you specify repositories with repositoryNames.

      This token should be treated as an opaque identifier that is only used 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 repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.


  • On success, responds with DescribeRepositoriesOutput with field(s):
    • repositories(Option<Vec::<Repository>>):

      A list of repository objects corresponding to valid repositories.

    • next_token(Option<String>):

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

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

impl Client

Source

pub fn describe_repository_creation_templates( &self, ) -> DescribeRepositoryCreationTemplatesFluentBuilder

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

  • The fluent builder is configurable:
    • prefixes(impl Into<String>) / set_prefixes(Option<Vec::<String>>):
      required: false

      The repository namespace prefixes associated with the repository creation templates to describe. If this value is not specified, all repository creation templates are returned.


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

      The nextToken value returned from a previous paginated DescribeRepositoryCreationTemplates 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 only used 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 repository results returned by DescribeRepositoryCreationTemplatesRequest in paginated output. When this parameter is used, DescribeRepositoryCreationTemplatesRequest only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositoryCreationTemplatesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositoryCreationTemplatesRequest returns up to 100 results and a nextToken value, if applicable.


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

impl Client

Source

pub fn get_account_setting(&self) -> GetAccountSettingFluentBuilder

Constructs a fluent builder for the GetAccountSetting operation.

Source§

impl Client

Source

pub fn get_authorization_token(&self) -> GetAuthorizationTokenFluentBuilder

Constructs a fluent builder for the GetAuthorizationToken operation.

Source§

impl Client

Source

pub fn get_download_url_for_layer(&self) -> GetDownloadUrlForLayerFluentBuilder

Constructs a fluent builder for the GetDownloadUrlForLayer operation.

Source§

impl Client

Source

pub fn get_lifecycle_policy(&self) -> GetLifecyclePolicyFluentBuilder

Constructs a fluent builder for the GetLifecyclePolicy operation.

Source§

impl Client

Source

pub fn get_lifecycle_policy_preview( &self, ) -> GetLifecyclePolicyPreviewFluentBuilder

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

Source§

impl Client

Source

pub fn get_registry_policy(&self) -> GetRegistryPolicyFluentBuilder

Constructs a fluent builder for the GetRegistryPolicy operation.

Source§

impl Client

Source

pub fn get_registry_scanning_configuration( &self, ) -> GetRegistryScanningConfigurationFluentBuilder

Constructs a fluent builder for the GetRegistryScanningConfiguration operation.

Source§

impl Client

Source

pub fn get_repository_policy(&self) -> GetRepositoryPolicyFluentBuilder

Constructs a fluent builder for the GetRepositoryPolicy operation.

Source§

impl Client

Source

pub fn initiate_layer_upload(&self) -> InitiateLayerUploadFluentBuilder

Constructs a fluent builder for the InitiateLayerUpload operation.

Source§

impl Client

Source

pub fn list_images(&self) -> ListImagesFluentBuilder

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

  • The fluent builder is configurable:
    • registry_id(impl Into<String>) / set_registry_id(Option<String>):
      required: false

      The Amazon Web Services account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.


    • repository_name(impl Into<String>) / set_repository_name(Option<String>):
      required: true

      The repository with image IDs to be listed.


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

      The nextToken value returned from a previous paginated ListImages 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 only used 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 image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.


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

      The filter key and value with which to filter your ListImages results.


  • On success, responds with ListImagesOutput with field(s):
    • image_ids(Option<Vec::<ImageIdentifier>>):

      The list of image IDs for the requested repository.

    • next_token(Option<String>):

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

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

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

Source§

impl Client

Source

pub fn put_account_setting(&self) -> PutAccountSettingFluentBuilder

Constructs a fluent builder for the PutAccountSetting operation.

Source§

impl Client

Source

pub fn put_image(&self) -> PutImageFluentBuilder

Constructs a fluent builder for the PutImage operation.

Source§

impl Client

Source

pub fn put_image_scanning_configuration( &self, ) -> PutImageScanningConfigurationFluentBuilder

Constructs a fluent builder for the PutImageScanningConfiguration operation.

Source§

impl Client

Source

pub fn put_image_tag_mutability(&self) -> PutImageTagMutabilityFluentBuilder

Constructs a fluent builder for the PutImageTagMutability operation.

Source§

impl Client

Source

pub fn put_lifecycle_policy(&self) -> PutLifecyclePolicyFluentBuilder

Constructs a fluent builder for the PutLifecyclePolicy operation.

Source§

impl Client

Source

pub fn put_registry_policy(&self) -> PutRegistryPolicyFluentBuilder

Constructs a fluent builder for the PutRegistryPolicy operation.

Source§

impl Client

Source

pub fn put_registry_scanning_configuration( &self, ) -> PutRegistryScanningConfigurationFluentBuilder

Constructs a fluent builder for the PutRegistryScanningConfiguration operation.

Source§

impl Client

Source

pub fn put_replication_configuration( &self, ) -> PutReplicationConfigurationFluentBuilder

Constructs a fluent builder for the PutReplicationConfiguration operation.

Source§

impl Client

Source

pub fn set_repository_policy(&self) -> SetRepositoryPolicyFluentBuilder

Constructs a fluent builder for the SetRepositoryPolicy operation.

Source§

impl Client

Source

pub fn start_image_scan(&self) -> StartImageScanFluentBuilder

Constructs a fluent builder for the StartImageScan operation.

Source§

impl Client

Source

pub fn start_lifecycle_policy_preview( &self, ) -> StartLifecyclePolicyPreviewFluentBuilder

Constructs a fluent builder for the StartLifecyclePolicyPreview 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_pull_through_cache_rule( &self, ) -> UpdatePullThroughCacheRuleFluentBuilder

Constructs a fluent builder for the UpdatePullThroughCacheRule operation.

Source§

impl Client

Source

pub fn update_repository_creation_template( &self, ) -> UpdateRepositoryCreationTemplateFluentBuilder

Constructs a fluent builder for the UpdateRepositoryCreationTemplate operation.

Source§

impl Client

Source

pub fn upload_layer_part(&self) -> UploadLayerPartFluentBuilder

Constructs a fluent builder for the UploadLayerPart operation.

Source§

impl Client

Source

pub fn validate_pull_through_cache_rule( &self, ) -> ValidatePullThroughCacheRuleFluentBuilder

Constructs a fluent builder for the ValidatePullThroughCacheRule 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_image_scan_complete(&self) -> ImageScanCompleteFluentBuilder

Wait until an image scan is complete and findings can be accessed
Source§

fn wait_until_lifecycle_policy_preview_complete( &self, ) -> LifecyclePolicyPreviewCompleteFluentBuilder

Wait until a lifecycle policy preview request is complete and results can be accessed

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

Source§

impl<T> MaybeSendSync for T