Struct Client

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

Client for AWS Lambda

Client for invoking operations on AWS Lambda. Each operation on AWS Lambda 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_lambda::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_lambda::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 AddLayerVersionPermission operation has a Client::add_layer_version_permission, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.add_layer_version_permission()
    .layer_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 add_layer_version_permission( &self, ) -> AddLayerVersionPermissionFluentBuilder

Constructs a fluent builder for the AddLayerVersionPermission operation.

Source§

impl Client

Source

pub fn add_permission(&self) -> AddPermissionFluentBuilder

Constructs a fluent builder for the AddPermission operation.

Source§

impl Client

Source

pub fn create_alias(&self) -> CreateAliasFluentBuilder

Constructs a fluent builder for the CreateAlias operation.

Source§

impl Client

Source

pub fn create_code_signing_config(&self) -> CreateCodeSigningConfigFluentBuilder

Constructs a fluent builder for the CreateCodeSigningConfig operation.

Source§

impl Client

Source

pub fn create_event_source_mapping( &self, ) -> CreateEventSourceMappingFluentBuilder

Constructs a fluent builder for the CreateEventSourceMapping operation.

Source§

impl Client

Source

pub fn create_function(&self) -> CreateFunctionFluentBuilder

Constructs a fluent builder for the CreateFunction operation.

Source§

impl Client

Source

pub fn create_function_url_config(&self) -> CreateFunctionUrlConfigFluentBuilder

Constructs a fluent builder for the CreateFunctionUrlConfig operation.

Source§

impl Client

Source

pub fn delete_alias(&self) -> DeleteAliasFluentBuilder

Constructs a fluent builder for the DeleteAlias operation.

Source§

impl Client

Source

pub fn delete_code_signing_config(&self) -> DeleteCodeSigningConfigFluentBuilder

Constructs a fluent builder for the DeleteCodeSigningConfig operation.

Source§

impl Client

Source

pub fn delete_event_source_mapping( &self, ) -> DeleteEventSourceMappingFluentBuilder

Constructs a fluent builder for the DeleteEventSourceMapping operation.

Source§

impl Client

Source

pub fn delete_function(&self) -> DeleteFunctionFluentBuilder

Constructs a fluent builder for the DeleteFunction operation.

Source§

impl Client

Source

pub fn delete_function_code_signing_config( &self, ) -> DeleteFunctionCodeSigningConfigFluentBuilder

Constructs a fluent builder for the DeleteFunctionCodeSigningConfig operation.

Source§

impl Client

Source

pub fn delete_function_concurrency( &self, ) -> DeleteFunctionConcurrencyFluentBuilder

Constructs a fluent builder for the DeleteFunctionConcurrency operation.

Source§

impl Client

Source

pub fn delete_function_event_invoke_config( &self, ) -> DeleteFunctionEventInvokeConfigFluentBuilder

Constructs a fluent builder for the DeleteFunctionEventInvokeConfig operation.

Source§

impl Client

Source

pub fn delete_function_url_config(&self) -> DeleteFunctionUrlConfigFluentBuilder

Constructs a fluent builder for the DeleteFunctionUrlConfig operation.

Source§

impl Client

Source

pub fn delete_layer_version(&self) -> DeleteLayerVersionFluentBuilder

Constructs a fluent builder for the DeleteLayerVersion operation.

Source§

impl Client

Source

pub fn delete_provisioned_concurrency_config( &self, ) -> DeleteProvisionedConcurrencyConfigFluentBuilder

Constructs a fluent builder for the DeleteProvisionedConcurrencyConfig operation.

Source§

impl Client

Source

pub fn get_account_settings(&self) -> GetAccountSettingsFluentBuilder

Constructs a fluent builder for the GetAccountSettings operation.

Source§

impl Client

Source

pub fn get_alias(&self) -> GetAliasFluentBuilder

Constructs a fluent builder for the GetAlias operation.

Source§

impl Client

Source

pub fn get_code_signing_config(&self) -> GetCodeSigningConfigFluentBuilder

Constructs a fluent builder for the GetCodeSigningConfig operation.

Source§

impl Client

Source

pub fn get_event_source_mapping(&self) -> GetEventSourceMappingFluentBuilder

Constructs a fluent builder for the GetEventSourceMapping operation.

Source§

impl Client

Source

pub fn get_function(&self) -> GetFunctionFluentBuilder

Constructs a fluent builder for the GetFunction operation.

Source§

impl Client

Source

pub fn get_function_code_signing_config( &self, ) -> GetFunctionCodeSigningConfigFluentBuilder

Constructs a fluent builder for the GetFunctionCodeSigningConfig operation.

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

      The name or ARN of the Lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.


  • On success, responds with GetFunctionCodeSigningConfigOutput with field(s):
    • code_signing_config_arn(String):

      The The Amazon Resource Name (ARN) of the code signing configuration.

    • function_name(String):

      The name or ARN of the Lambda function.

      Name formats

      • Function name - MyFunction.

      • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Partial ARN - 123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

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

impl Client

Source

pub fn get_function_concurrency(&self) -> GetFunctionConcurrencyFluentBuilder

Constructs a fluent builder for the GetFunctionConcurrency operation.

Source§

impl Client

Source

pub fn get_function_configuration( &self, ) -> GetFunctionConfigurationFluentBuilder

Constructs a fluent builder for the GetFunctionConfiguration operation.

Source§

impl Client

Source

pub fn get_function_event_invoke_config( &self, ) -> GetFunctionEventInvokeConfigFluentBuilder

Constructs a fluent builder for the GetFunctionEventInvokeConfig operation.

Source§

impl Client

Source

pub fn get_function_recursion_config( &self, ) -> GetFunctionRecursionConfigFluentBuilder

Constructs a fluent builder for the GetFunctionRecursionConfig operation.

Source§

impl Client

Source

pub fn get_function_url_config(&self) -> GetFunctionUrlConfigFluentBuilder

Constructs a fluent builder for the GetFunctionUrlConfig operation.

Source§

impl Client

Source

pub fn get_layer_version(&self) -> GetLayerVersionFluentBuilder

Constructs a fluent builder for the GetLayerVersion operation.

Source§

impl Client

Source

pub fn get_layer_version_by_arn(&self) -> GetLayerVersionByArnFluentBuilder

Constructs a fluent builder for the GetLayerVersionByArn operation.

Source§

impl Client

Source

pub fn get_layer_version_policy(&self) -> GetLayerVersionPolicyFluentBuilder

Constructs a fluent builder for the GetLayerVersionPolicy operation.

Source§

impl Client

Source

pub fn get_policy(&self) -> GetPolicyFluentBuilder

Constructs a fluent builder for the GetPolicy operation.

Source§

impl Client

Source

pub fn get_provisioned_concurrency_config( &self, ) -> GetProvisionedConcurrencyConfigFluentBuilder

Constructs a fluent builder for the GetProvisionedConcurrencyConfig operation.

Source§

impl Client

Source

pub fn get_runtime_management_config( &self, ) -> GetRuntimeManagementConfigFluentBuilder

Constructs a fluent builder for the GetRuntimeManagementConfig operation.

Source§

impl Client

Source

pub fn invoke(&self) -> InvokeFluentBuilder

Constructs a fluent builder for the Invoke operation.

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

      The name or ARN of the Lambda function, version, or alias.

      Name formats

      • Function namemy-function (name-only), my-function:v1 (with alias).

      • Function ARNarn:aws:lambda:us-west-2:123456789012:function:my-function.

      • Partial ARN123456789012:function:my-function.

      You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.


    • invocation_type(InvocationType) / set_invocation_type(Option<InvocationType>):
      required: false

      Choose from the following options.

      • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

      • Event – Invoke the function asynchronously. Send events that fail multiple times to the function’s dead-letter queue (if one is configured). The API response only includes a status code.

      • DryRun – Validate parameter values and verify that the user or role has permission to invoke the function.


    • log_type(LogType) / set_log_type(Option<LogType>):
      required: false

      Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.


    • client_context(impl Into<String>) / set_client_context(Option<String>):
      required: false

      Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.


    • payload(Blob) / set_payload(Option<Blob>):
      required: false

      The JSON that you want to provide to your Lambda function as input.

      You can enter the JSON directly. For example, –payload ‘{ “key”: “value” }’. You can also specify a file path. For example, –payload file://payload.json.


    • qualifier(impl Into<String>) / set_qualifier(Option<String>):
      required: false

      Specify a version or alias to invoke a published version of the function.


  • On success, responds with InvokeOutput with field(s):
    • status_code(i32):

      The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.

    • function_error(Option<String>):

      If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.

    • log_result(Option<String>):

      The last 4 KB of the execution log, which is base64-encoded.

    • payload(Option<Blob>):

      The response from the function, or an error object.

    • executed_version(Option<String>):

      The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

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

impl Client

Source

pub fn invoke_async(&self) -> InvokeAsyncFluentBuilder

👎Deprecated

Constructs a fluent builder for the InvokeAsync operation.

Source§

impl Client

Source

pub fn invoke_with_response_stream( &self, ) -> InvokeWithResponseStreamFluentBuilder

Constructs a fluent builder for the InvokeWithResponseStream operation.

Source§

impl Client

Source

pub fn list_aliases(&self) -> ListAliasesFluentBuilder

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

Source§

impl Client

Source

pub fn list_code_signing_configs(&self) -> ListCodeSigningConfigsFluentBuilder

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

Source§

impl Client

Source

pub fn list_event_source_mappings(&self) -> ListEventSourceMappingsFluentBuilder

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

Source§

impl Client

Source

pub fn list_function_event_invoke_configs( &self, ) -> ListFunctionEventInvokeConfigsFluentBuilder

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

Source§

impl Client

Source

pub fn list_function_url_configs(&self) -> ListFunctionUrlConfigsFluentBuilder

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

Source§

impl Client

Source

pub fn list_functions(&self) -> ListFunctionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_functions_by_code_signing_config( &self, ) -> ListFunctionsByCodeSigningConfigFluentBuilder

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

Source§

impl Client

Source

pub fn list_layer_versions(&self) -> ListLayerVersionsFluentBuilder

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

Source§

impl Client

Source

pub fn list_layers(&self) -> ListLayersFluentBuilder

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

Source§

impl Client

Source

pub fn list_provisioned_concurrency_configs( &self, ) -> ListProvisionedConcurrencyConfigsFluentBuilder

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

Source§

impl Client

Source

pub fn list_tags(&self) -> ListTagsFluentBuilder

Constructs a fluent builder for the ListTags operation.

Source§

impl Client

Source

pub fn list_versions_by_function(&self) -> ListVersionsByFunctionFluentBuilder

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

Source§

impl Client

Source

pub fn publish_layer_version(&self) -> PublishLayerVersionFluentBuilder

Constructs a fluent builder for the PublishLayerVersion operation.

Source§

impl Client

Source

pub fn publish_version(&self) -> PublishVersionFluentBuilder

Constructs a fluent builder for the PublishVersion operation.

Source§

impl Client

Source

pub fn put_function_code_signing_config( &self, ) -> PutFunctionCodeSigningConfigFluentBuilder

Constructs a fluent builder for the PutFunctionCodeSigningConfig operation.

Source§

impl Client

Source

pub fn put_function_concurrency(&self) -> PutFunctionConcurrencyFluentBuilder

Constructs a fluent builder for the PutFunctionConcurrency operation.

Source§

impl Client

Source

pub fn put_function_event_invoke_config( &self, ) -> PutFunctionEventInvokeConfigFluentBuilder

Constructs a fluent builder for the PutFunctionEventInvokeConfig operation.

Source§

impl Client

Source

pub fn put_function_recursion_config( &self, ) -> PutFunctionRecursionConfigFluentBuilder

Constructs a fluent builder for the PutFunctionRecursionConfig operation.

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

      The name or ARN of the Lambda function.

      Name formats

      • Function namemy-function.

      • Function ARNarn:aws:lambda:us-west-2:123456789012:function:my-function.

      • Partial ARN123456789012:function:my-function.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.


    • recursive_loop(RecursiveLoop) / set_recursive_loop(Option<RecursiveLoop>):
      required: true

      If you set your function’s recursive loop detection configuration to Allow, Lambda doesn’t take any action when it detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes it.

      If you set your function’s recursive loop detection configuration to Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.

      By default, Lambda sets your function’s configuration to Terminate.

      If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see Recursive patterns that cause run-away Lambda functions in Serverless Land.


  • On success, responds with PutFunctionRecursionConfigOutput with field(s):
    • recursive_loop(Option<RecursiveLoop>):

      The status of your function’s recursive loop detection configuration.

      When this value is set to Allowand Lambda detects your function being invoked as part of a recursive loop, it doesn’t take any action.

      When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.

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

impl Client

Source

pub fn put_provisioned_concurrency_config( &self, ) -> PutProvisionedConcurrencyConfigFluentBuilder

Constructs a fluent builder for the PutProvisionedConcurrencyConfig operation.

Source§

impl Client

Source

pub fn put_runtime_management_config( &self, ) -> PutRuntimeManagementConfigFluentBuilder

Constructs a fluent builder for the PutRuntimeManagementConfig operation.

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

      The name or ARN of the Lambda function.

      Name formats

      • Function namemy-function.

      • Function ARNarn:aws:lambda:us-west-2:123456789012:function:my-function.

      • Partial ARN123456789012:function:my-function.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.


    • qualifier(impl Into<String>) / set_qualifier(Option<String>):
      required: false

      Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.


    • update_runtime_on(UpdateRuntimeOn) / set_update_runtime_on(Option<UpdateRuntimeOn>):
      required: true

      Specify the runtime update mode.

      • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.

      • Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.

      • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.


    • runtime_version_arn(impl Into<String>) / set_runtime_version_arn(Option<String>):
      required: false

      The ARN of the runtime version you want the function to use.

      This is only required if you’re using the Manual runtime update mode.


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

impl Client

Source

pub fn remove_layer_version_permission( &self, ) -> RemoveLayerVersionPermissionFluentBuilder

Constructs a fluent builder for the RemoveLayerVersionPermission operation.

Source§

impl Client

Source

pub fn remove_permission(&self) -> RemovePermissionFluentBuilder

Constructs a fluent builder for the RemovePermission 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_alias(&self) -> UpdateAliasFluentBuilder

Constructs a fluent builder for the UpdateAlias operation.

Source§

impl Client

Source

pub fn update_code_signing_config(&self) -> UpdateCodeSigningConfigFluentBuilder

Constructs a fluent builder for the UpdateCodeSigningConfig operation.

Source§

impl Client

Source

pub fn update_event_source_mapping( &self, ) -> UpdateEventSourceMappingFluentBuilder

Constructs a fluent builder for the UpdateEventSourceMapping operation.

Source§

impl Client

Source

pub fn update_function_code(&self) -> UpdateFunctionCodeFluentBuilder

Constructs a fluent builder for the UpdateFunctionCode operation.

Source§

impl Client

Source

pub fn update_function_configuration( &self, ) -> UpdateFunctionConfigurationFluentBuilder

Constructs a fluent builder for the UpdateFunctionConfiguration operation.

Source§

impl Client

Source

pub fn update_function_event_invoke_config( &self, ) -> UpdateFunctionEventInvokeConfigFluentBuilder

Constructs a fluent builder for the UpdateFunctionEventInvokeConfig operation.

Source§

impl Client

Source

pub fn update_function_url_config(&self) -> UpdateFunctionUrlConfigFluentBuilder

Constructs a fluent builder for the UpdateFunctionUrlConfig 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_function_active_v2(&self) -> FunctionActiveV2FluentBuilder

Waits for the function’s State to be Active. This waiter uses GetFunction API. This should be used after new function creation.
Source§

fn wait_until_function_exists(&self) -> FunctionExistsFluentBuilder

Wait for function_exists
Source§

fn wait_until_function_updated_v2(&self) -> FunctionUpdatedV2FluentBuilder

Waits for the function’s LastUpdateStatus to be Successful. This waiter uses GetFunction API. This should be used after function updates.
Source§

fn wait_until_function_active(&self) -> FunctionActiveFluentBuilder

Waits for the function’s State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new function creation.
Source§

fn wait_until_function_updated(&self) -> FunctionUpdatedFluentBuilder

Waits for the function’s LastUpdateStatus to be Successful. This waiter uses GetFunctionConfiguration API. This should be used after function updates.
Source§

fn wait_until_published_version_active( &self, ) -> PublishedVersionActiveFluentBuilder

Waits for the published version’s State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new version is published.

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,

Source§

impl<T> MaybeSendSync for T