Struct aws_smithy_runtime_api::client::interceptors::context::InterceptorContext

pub struct InterceptorContext<I = Input, O = Output, E = Error>where
    E: Debug,{ /* private fields */ }

A container for the data currently available to an interceptor.

Different context is available based on which phase the operation is currently in. For example, context in the Phase::BeforeSerialization phase won’t have a request yet since the input hasn’t been serialized at that point. But once it gets into the Phase::BeforeTransmit phase, the request will be set.

Implementations

impl InterceptorContext<Input, Output, Error>

pub fn new(input: Input) -> InterceptorContext<Input, Output, Error>

Creates a new interceptor context in the Phase::BeforeSerialization phase.

impl<I, O, E> InterceptorContext<I, O, E>where E: Debug,

pub fn finalize(self) -> Result<O, SdkError<E, HttpResponse>>

pub fn input(&self) -> &I

Retrieve the input for the operation being invoked.

pub fn input_mut(&mut self) -> &mut I

Retrieve the input for the operation being invoked.

pub fn take_input(&mut self) -> Option<I>

Takes ownership of the input.

pub fn set_request(&mut self, request: HttpRequest)

Set the request for the operation being invoked.

pub fn request(&self) -> &HttpRequest

Retrieve the transmittable request for the operation being invoked. This will only be available once request marshalling has completed.

pub fn request_mut(&mut self) -> &mut HttpRequest

Retrieve the transmittable request for the operation being invoked. This will only be available once request marshalling has completed.

pub fn take_request(&mut self) -> HttpRequest

Takes ownership of the request.

pub fn set_response(&mut self, response: HttpResponse)

Set the response for the operation being invoked.

pub fn response(&self) -> &HttpResponse

Returns the response.

pub fn response_mut(&mut self) -> &mut HttpResponse

Returns a mutable reference to the response.

pub fn set_output_or_error(&mut self, output: Result<O, OrchestratorError<E>>)

Set the output or error for the operation being invoked.

pub fn output_or_error(&self) -> Result<&O, &OrchestratorError<E>>

Returns the deserialized output or error.

pub fn output_or_error_mut(&mut self) -> &mut Result<O, OrchestratorError<E>>

Returns the mutable reference to the deserialized output or error.

pub fn rewind(&mut self, _cfg: &mut ConfigBag) -> bool

pub fn fail(&mut self, error: OrchestratorError<E>)

Mark this context as failed due to errors during the operation. Any errors already contained by the context will be replaced by the given error.

pub fn is_failed(&self) -> bool

Return true if this context’s output_or_error is an error. Otherwise, return false.

Trait Implementations

impl<I: Debug, O: Debug, E> Debug for InterceptorContext<I, O, E>where E: Debug + Debug,

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

Formats the value using the given formatter.

impl<'a, I, O, E: Debug> From<&'a InterceptorContext<I, O, E>> for AfterDeserializationInterceptorContextRef<'a, I, O, E>

fn from(inner: &'a InterceptorContext<I, O, E>) -> Self

Converts to this type from the input type.

impl<'a, I, O, E: Debug> From<&'a InterceptorContext<I, O, E>> for BeforeDeserializationInterceptorContextRef<'a, I, O, E>

fn from(inner: &'a InterceptorContext<I, O, E>) -> Self

Converts to this type from the input type.

impl<'a, I, O, E: Debug> From<&'a InterceptorContext<I, O, E>> for BeforeSerializationInterceptorContextRef<'a, I, O, E>

fn from(inner: &'a InterceptorContext<I, O, E>) -> Self

Converts to this type from the input type.

impl<'a, I, O, E: Debug> From<&'a InterceptorContext<I, O, E>> for BeforeTransmitInterceptorContextRef<'a, I, O, E>

fn from(inner: &'a InterceptorContext<I, O, E>) -> Self

Converts to this type from the input type.

impl<'a, I, O, E: Debug> From<&'a InterceptorContext<I, O, E>> for FinalizerInterceptorContextRef<'a, I, O, E>

fn from(inner: &'a InterceptorContext<I, O, E>) -> Self

Converts to this type from the input type.

impl<'a, I, O, E: Debug> From<&'a mut InterceptorContext<I, O, E>> for AfterDeserializationInterceptorContextMut<'a, I, O, E>

fn from(inner: &'a mut InterceptorContext<I, O, E>) -> Self

Converts to this type from the input type.

impl<'a, I, O, E: Debug> From<&'a mut InterceptorContext<I, O, E>> for BeforeDeserializationInterceptorContextMut<'a, I, O, E>

fn from(inner: &'a mut InterceptorContext<I, O, E>) -> Self

Converts to this type from the input type.

impl<'a, I, O, E: Debug> From<&'a mut InterceptorContext<I, O, E>> for BeforeSerializationInterceptorContextMut<'a, I, O, E>

fn from(inner: &'a mut InterceptorContext<I, O, E>) -> Self

Converts to this type from the input type.

impl<'a, I, O, E: Debug> From<&'a mut InterceptorContext<I, O, E>> for BeforeTransmitInterceptorContextMut<'a, I, O, E>

fn from(inner: &'a mut InterceptorContext<I, O, E>) -> Self

Converts to this type from the input type.

impl<'a, I, O, E: Debug> From<&'a mut InterceptorContext<I, O, E>> for FinalizerInterceptorContextMut<'a, I, O, E>

fn from(inner: &'a mut InterceptorContext<I, O, E>) -> Self

Converts to this type from the input type.