Struct InterceptorContext

pub struct InterceptorContext<I = Input, O = Output, E = Error> { /* 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 “before serialization” phase won’t have a request yet since the input hasn’t been serialized at that point. But once it gets into the “before transmit” 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 “before serialization” phase.

impl<I, O, E> InterceptorContext<I, O, E>

pub fn input(&self) -> Option<&I>

Retrieve the input for the operation being invoked.

Note: This method is intended for internal use only.

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

Retrieve the input for the operation being invoked.

Note: This method is intended for internal use only.

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

Takes ownership of the input.

Note: This method is intended for internal use only.

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

Set the request for the operation being invoked.

Note: This method is intended for internal use only.

pub fn request(&self) -> Option<&HttpRequest>

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

Note: This method is intended for internal use only.

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

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

Note: This method is intended for internal use only.

pub fn take_request(&mut self) -> Option<HttpRequest>

Takes ownership of the request.

Note: This method is intended for internal use only.

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

Set the response for the operation being invoked.

Note: This method is intended for internal use only.

pub fn response(&self) -> Option<&HttpResponse>

Returns the response.

Note: This method is intended for internal use only.

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

Returns a mutable reference to the response.

Note: This method is intended for internal use only.

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

Set the output or error for the operation being invoked.

Note: This method is intended for internal use only.

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

Returns the deserialized output or error.

Note: This method is intended for internal use only.

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

Returns the mutable reference to the deserialized output or error.

Note: This method is intended for internal use only.

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

Grants ownership of the deserialized output/error.

Note: This method is intended for internal use only.

pub fn is_failed(&self) -> bool

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

Note: This method is intended for internal use only.

pub fn enter_serialization_phase(&mut self)

Advance to the Serialization phase.

Note: This method is intended for internal use only.

pub fn enter_before_transmit_phase(&mut self)

Advance to the BeforeTransmit phase.

Note: This method is intended for internal use only.

pub fn enter_transmit_phase(&mut self)

Advance to the Transmit phase.

Note: This method is intended for internal use only.

pub fn enter_before_deserialization_phase(&mut self)

Advance to the BeforeDeserialization phase.

Note: This method is intended for internal use only.

pub fn enter_deserialization_phase(&mut self)

Advance to the Deserialization phase.

Note: This method is intended for internal use only.

pub fn enter_after_deserialization_phase(&mut self)

Advance to the AfterDeserialization phase.

Note: This method is intended for internal use only.

pub fn save_checkpoint(&mut self)

Set the request checkpoint. This should only be called once, right before entering the retry loop.

Note: This method is intended for internal use only.

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

Returns false if rewinding isn’t possible

Note: This method is intended for internal use only.

impl<I, O, E> InterceptorContext<I, O, E>

where E: Debug,

pub fn into_parts( self, ) -> (Option<I>, Option<Result<O, OrchestratorError<E>>>, Option<HttpRequest>, Option<HttpResponse>)

Decomposes the context into its constituent parts.

Note: This method is intended for internal use only.

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

Convert this context into the final operation result that is returned in client’s the public API.

Note: This method is intended for internal use only.

pub fn finalize_result( &mut self, result: Result<O, OrchestratorError<E>>, ) -> Result<O, SdkError<E, HttpResponse>>

Convert the given output/error into a final operation result that is returned in the client’s public API.

Note: This method is intended for internal use only.

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.

Note: This method is intended for internal use only.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'a, I, O, E> 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> 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> 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> 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> 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> 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> 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> 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> 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.