Struct aws_runtime::user_agent::UserAgentInterceptor
source · #[non_exhaustive]pub struct UserAgentInterceptor;
Expand description
Generates and attaches the AWS SDK’s user agent to a HTTP request
Implementations§
Trait Implementations§
source§impl Debug for UserAgentInterceptor
impl Debug for UserAgentInterceptor
source§impl Default for UserAgentInterceptor
impl Default for UserAgentInterceptor
source§fn default() -> UserAgentInterceptor
fn default() -> UserAgentInterceptor
Returns the “default value” for a type. Read more
source§impl Interceptor for UserAgentInterceptor
impl Interceptor for UserAgentInterceptor
source§fn name(&self) -> &'static str
fn name(&self) -> &'static str
The name of this interceptor, used in error messages for debugging.
source§fn modify_before_signing(
&self,
context: &mut BeforeTransmitInterceptorContextMut<'_>,
_runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), BoxError>
fn modify_before_signing( &self, context: &mut BeforeTransmitInterceptorContextMut<'_>, _runtime_components: &RuntimeComponents, 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. Read more
source§fn read_before_execution(
&self,
context: &BeforeSerializationInterceptorContextRef<'_, Input, Output, Error>,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_before_execution( &self, context: &BeforeSerializationInterceptorContextRef<'_, Input, Output, Error>, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called at the start of an execution, before the SDK
does anything else. Read more
source§fn modify_before_serialization(
&self,
context: &mut BeforeSerializationInterceptorContextMut<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn modify_before_serialization( &self, context: &mut BeforeSerializationInterceptorContextMut<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, 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. Read more
source§fn read_before_serialization(
&self,
context: &BeforeSerializationInterceptorContextRef<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_before_serialization( &self, context: &BeforeSerializationInterceptorContextRef<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called before the input message is marshalled
into a transport
message. Read more
source§fn read_after_serialization(
&self,
context: &BeforeTransmitInterceptorContextRef<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_after_serialization( &self, context: &BeforeTransmitInterceptorContextRef<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called after the input message is marshalled into
a transport message. Read more
source§fn modify_before_retry_loop(
&self,
context: &mut BeforeTransmitInterceptorContextMut<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn modify_before_retry_loop( &self, context: &mut BeforeTransmitInterceptorContextMut<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, 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. Read more
source§fn read_before_attempt(
&self,
context: &BeforeTransmitInterceptorContextRef<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_before_attempt( &self, context: &BeforeTransmitInterceptorContextRef<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called before each attempt at sending the transmission
request message to the service. Read more
source§fn read_before_signing(
&self,
context: &BeforeTransmitInterceptorContextRef<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_before_signing( &self, context: &BeforeTransmitInterceptorContextRef<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called before the transport request message is signed. Read more
source§fn read_after_signing(
&self,
context: &BeforeTransmitInterceptorContextRef<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_after_signing( &self, context: &BeforeTransmitInterceptorContextRef<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called after the transport request message is signed. Read more
source§fn modify_before_transmit(
&self,
context: &mut BeforeTransmitInterceptorContextMut<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn modify_before_transmit( &self, context: &mut BeforeTransmitInterceptorContextMut<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, 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. Read more
source§fn read_before_transmit(
&self,
context: &BeforeTransmitInterceptorContextRef<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_before_transmit( &self, context: &BeforeTransmitInterceptorContextRef<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called before the transport request message is sent to the
service. Read more
source§fn read_after_transmit(
&self,
context: &BeforeDeserializationInterceptorContextRef<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_after_transmit( &self, context: &BeforeDeserializationInterceptorContextRef<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called after the transport request message is sent to the
service and a transport response message is received. Read more
source§fn modify_before_deserialization(
&self,
context: &mut BeforeDeserializationInterceptorContextMut<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn modify_before_deserialization( &self, context: &mut BeforeDeserializationInterceptorContextMut<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, 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. Read more
source§fn read_before_deserialization(
&self,
context: &BeforeDeserializationInterceptorContextRef<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_before_deserialization( &self, context: &BeforeDeserializationInterceptorContextRef<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called before the transport response message is unmarshalled Read more
source§fn read_after_deserialization(
&self,
context: &AfterDeserializationInterceptorContextRef<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_after_deserialization( &self, context: &AfterDeserializationInterceptorContextRef<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called after the transport response message is unmarshalled. Read more
source§fn modify_before_attempt_completion(
&self,
context: &mut FinalizerInterceptorContextMut<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn modify_before_attempt_completion( &self, context: &mut FinalizerInterceptorContextMut<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, 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. Read more
source§fn read_after_attempt(
&self,
context: &FinalizerInterceptorContextRef<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn read_after_attempt( &self, context: &FinalizerInterceptorContextRef<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, Global>>
A hook called when an attempt is completed. Read more
source§fn modify_before_completion(
&self,
context: &mut FinalizerInterceptorContextMut<'_, Input, Output, Error>,
runtime_components: &RuntimeComponents,
cfg: &mut ConfigBag
) -> Result<(), Box<dyn Error + Sync + Send, Global>>
fn modify_before_completion( &self, context: &mut FinalizerInterceptorContextMut<'_, Input, Output, Error>, runtime_components: &RuntimeComponents, cfg: &mut ConfigBag ) -> Result<(), Box<dyn Error + Sync + Send, 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. Read more
Auto Trait Implementations§
impl RefUnwindSafe for UserAgentInterceptor
impl Send for UserAgentInterceptor
impl Sync for UserAgentInterceptor
impl Unpin for UserAgentInterceptor
impl UnwindSafe for UserAgentInterceptor
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more