pub struct AwsUserAgent { /* private fields */ }
Expand description

AWS User Agent

Ths struct should be inserted into the PropertyBag during operation construction. UserAgentStage reads AwsUserAgent from the property bag and sets the User-Agent and x-amz-user-agent headers.

Implementations§

source§

impl AwsUserAgent

source

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.

source

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

source

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

Sets the app name for the user agent.

source

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

Sets the app name for the user agent.

source

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

source

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§

source§

impl Clone for AwsUserAgent

source§

fn clone(&self) -> AwsUserAgent

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 AwsUserAgent

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · 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 Twhere U: From<T>,

const: unstable · 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> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · 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