Struct aws_runtime::user_agent::UserAgentInterceptor

#[non_exhaustive]
pub struct UserAgentInterceptor;

Generates and attaches the AWS SDK’s user agent to a HTTP request

Implementations

impl UserAgentInterceptor

pub fn new() -> Self

Creates a new UserAgentInterceptor

Trait Implementations

impl Debug for UserAgentInterceptor

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

Formats the value using the given formatter.

impl Default for UserAgentInterceptor

fn default() -> UserAgentInterceptor

Returns the “default value” for a type.

impl Interceptor for UserAgentInterceptor

fn modify_before_signing( &self, context: &mut BeforeTransmitInterceptorContextMut<'_>, cfg: &mut ConfigBag ) -> Result<(), BoxError>

A hook called before the transport request message is signed. This method has the ability to modify and return a new transport request message of the same type.

fn read_before_execution( &self, context: &BeforeSerializationInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called at the start of an execution, before the SDK does anything else.

fn modify_before_serialization( &self, context: &mut BeforeSerializationInterceptorContextMut<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called before the input message is marshalled into a transport message. This method has the ability to modify and return a new request message of the same type.

fn read_before_serialization( &self, context: &BeforeSerializationInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called before the input message is marshalled into a transport message.

fn read_after_serialization( &self, context: &BeforeTransmitInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

/// A hook called after the input message is marshalled into /// a transport message. /// /// When: This will ALWAYS be called once per execution, except when a /// failure occurs earlier in the request pipeline. The duration /// between invocation of this hook and before_serialization is very /// close to the amount of time spent marshalling the request. /// /// Available Information: The InterceptorContext::input() /// and InterceptorContext::request() are ALWAYS available. /// Other information WILL NOT be available. /// /// Error Behavior: If errors are raised by this hook, /// execution will jump to modify_before_completion with the raised /// error as the InterceptorContext::output_or_error().

fn modify_before_retry_loop( &self, context: &mut BeforeTransmitInterceptorContextMut<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called before the retry loop is entered. This method has the ability to modify and return a new transport request message of the same type, except when a failure occurs earlier in the request pipeline.

fn read_before_attempt( &self, context: &BeforeTransmitInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called before each attempt at sending the transmission request message to the service.

fn read_before_signing( &self, context: &BeforeTransmitInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called before the transport request message is signed.

fn read_after_signing( &self, context: &BeforeTransmitInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called after the transport request message is signed.

fn modify_before_transmit( &self, context: &mut BeforeTransmitInterceptorContextMut<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

/// A hook called before the transport request message is sent to the /// service. This method has the ability to modify and return /// a new transport request message of the same type. /// /// When: This will ALWAYS be called once per attempt, except when a /// failure occurs earlier in the request pipeline. This method may be /// called multiple times in the event of retries. /// /// Available Information: The InterceptorContext::input() /// and InterceptorContext::request() are ALWAYS available. /// The http::Request may have been modified by earlier /// modify_before_transmit hooks, and may be modified further by later /// hooks. Other information WILL NOT be available. /// In the event of retries, the InterceptorContext will not include /// changes made in previous attempts (e.g. by request signers or other interceptors).

fn read_before_transmit( &self, context: &BeforeTransmitInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called before the transport request message is sent to the service.

fn read_after_transmit( &self, context: &BeforeDeserializationInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called after the transport request message is sent to the service and a transport response message is received.

fn modify_before_deserialization( &self, context: &mut BeforeDeserializationInterceptorContextMut<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called before the transport response message is unmarshalled. This method has the ability to modify and return a new transport response message of the same type.

fn read_before_deserialization( &self, context: &BeforeDeserializationInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called before the transport response message is unmarshalled

fn read_after_deserialization( &self, context: &AfterDeserializationInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called after the transport response message is unmarshalled.

fn modify_before_attempt_completion( &self, context: &mut FinalizerInterceptorContextMut<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called when an attempt is completed. This method has the ability to modify and return a new output message or error matching the currently-executing operation.

fn read_after_attempt( &self, context: &FinalizerInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called when an attempt is completed.

fn modify_before_completion( &self, context: &mut FinalizerInterceptorContextMut<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called when an execution is completed. This method has the ability to modify and return a new output message or error matching the currently - executing operation.

fn read_after_execution( &self, context: &FinalizerInterceptorContextRef<'_, TypeErasedBox, TypeErasedBox, TypeErasedError>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Send + Sync + 'static, Global>>

A hook called when an execution is completed.