Struct aws_runtime::user_agent::AwsUserAgent

pub struct AwsUserAgent { /* private fields */ }

AWS User Agent

Ths struct should be inserted into the ConfigBag during operation construction. The UserAgentInterceptor reads AwsUserAgent from the config bag and sets the User-Agent and x-amz-user-agent headers.

Implementations

impl AwsUserAgent

pub fn new_from_environment(env: Env, api_metadata: ApiMetadata) -> Self

Load a User Agent configuration from the environment

This utilizes BUILD_METADATA from aws_types to capture the Rust version & target platform. ApiMetadata provides the version & name of the specific service.

pub fn for_tests() -> Self

For test purposes, construct an environment-independent User Agent

Without this, running CI on a different platform would produce different user agent strings

pub fn with_additional_metadata(self, metadata: AdditionalMetadata) -> Self

Adds additional metadata to the user agent.

pub fn add_additional_metadata( &mut self, metadata: AdditionalMetadata, ) -> &mut Self

Adds additional metadata to the user agent.

pub fn with_app_name(self, app_name: AppName) -> Self

Sets the app name for the user agent.

pub fn set_app_name(&mut self, app_name: AppName) -> &mut Self

Sets the app name for the user agent.

pub fn aws_ua_header(&self) -> String

Generate a new-style user agent style header

This header should be set at x-amz-user-agent

pub fn ua_header(&self) -> String

Generate an old-style User-Agent header for backward compatibility

This header is intended to be set at User-Agent

Trait Implementations

impl Clone for AwsUserAgent

fn clone(&self) -> AwsUserAgent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AwsUserAgent

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

Formats the value using the given formatter.

impl Storable for AwsUserAgent

type Storer = StoreReplace<AwsUserAgent>

Specify how an item is stored in the config bag, e.g. StoreReplace and StoreAppend