pub struct InterceptorContext<I = Input, O = Output, E = Error> { /* private fields */ }Expand description
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§
source§impl InterceptorContext
impl InterceptorContext
sourcepub fn new(input: Input) -> InterceptorContext
pub fn new(input: Input) -> InterceptorContext
Creates a new interceptor context in the “before serialization” phase.
source§impl<I, O, E> InterceptorContext<I, O, E>
impl<I, O, E> InterceptorContext<I, O, E>
sourcepub fn input(&self) -> Option<&I>
pub fn input(&self) -> Option<&I>
Retrieve the input for the operation being invoked.
Note: This method is intended for internal use only.
sourcepub fn input_mut(&mut self) -> Option<&mut I>
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.
sourcepub fn take_input(&mut self) -> Option<I>
pub fn take_input(&mut self) -> Option<I>
Takes ownership of the input.
Note: This method is intended for internal use only.
sourcepub fn set_request(&mut self, request: Request)
pub fn set_request(&mut self, request: Request)
Set the request for the operation being invoked.
Note: This method is intended for internal use only.
sourcepub fn request(&self) -> Option<&Request>
pub fn request(&self) -> Option<&Request>
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.
sourcepub fn request_mut(&mut self) -> Option<&mut Request>
pub fn request_mut(&mut self) -> Option<&mut Request>
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.
sourcepub fn take_request(&mut self) -> Option<Request>
pub fn take_request(&mut self) -> Option<Request>
Takes ownership of the request.
Note: This method is intended for internal use only.
sourcepub fn set_response(&mut self, response: Response)
pub fn set_response(&mut self, response: Response)
Set the response for the operation being invoked.
Note: This method is intended for internal use only.
sourcepub fn response(&self) -> Option<&Response>
pub fn response(&self) -> Option<&Response>
Returns the response.
Note: This method is intended for internal use only.
sourcepub fn response_mut(&mut self) -> Option<&mut Response>
pub fn response_mut(&mut self) -> Option<&mut Response>
Returns a mutable reference to the response.
Note: This method is intended for internal use only.
sourcepub fn set_output_or_error(&mut self, output: Result<O, OrchestratorError<E>>)
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.
sourcepub fn output_or_error(&self) -> Option<Result<&O, &OrchestratorError<E>>>
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.
sourcepub fn output_or_error_mut(
&mut self,
) -> Option<&mut Result<O, OrchestratorError<E>>>
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.
sourcepub fn take_output_or_error(
&mut self,
) -> Option<Result<O, OrchestratorError<E>>>
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.
sourcepub fn is_failed(&self) -> bool
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.
sourcepub fn enter_serialization_phase(&mut self)
pub fn enter_serialization_phase(&mut self)
Advance to the Serialization phase.
Note: This method is intended for internal use only.
sourcepub fn enter_before_transmit_phase(&mut self)
pub fn enter_before_transmit_phase(&mut self)
Advance to the BeforeTransmit phase.
Note: This method is intended for internal use only.
sourcepub fn enter_transmit_phase(&mut self)
pub fn enter_transmit_phase(&mut self)
Advance to the Transmit phase.
Note: This method is intended for internal use only.
sourcepub fn enter_before_deserialization_phase(&mut self)
pub fn enter_before_deserialization_phase(&mut self)
Advance to the BeforeDeserialization phase.
Note: This method is intended for internal use only.
sourcepub fn enter_deserialization_phase(&mut self)
pub fn enter_deserialization_phase(&mut self)
Advance to the Deserialization phase.
Note: This method is intended for internal use only.
sourcepub fn enter_after_deserialization_phase(&mut self)
pub fn enter_after_deserialization_phase(&mut self)
Advance to the AfterDeserialization phase.
Note: This method is intended for internal use only.
sourcepub fn save_checkpoint(&mut self)
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.
sourcepub fn rewind(&mut self, _cfg: &mut ConfigBag) -> RewindResult
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.
source§impl<I, O, E> InterceptorContext<I, O, E>where
E: Debug,
impl<I, O, E> InterceptorContext<I, O, E>where
E: Debug,
sourcepub fn into_parts(
self,
) -> (Option<I>, Option<Result<O, OrchestratorError<E>>>, Option<Request>, Option<Response>)
pub fn into_parts( self, ) -> (Option<I>, Option<Result<O, OrchestratorError<E>>>, Option<Request>, Option<Response>)
Decomposes the context into its constituent parts.
Note: This method is intended for internal use only.
sourcepub fn finalize(self) -> Result<O, SdkError<E, Response>>
pub fn finalize(self) -> Result<O, SdkError<E, Response>>
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.
sourcepub fn finalize_result(
&mut self,
result: Result<O, OrchestratorError<E>>,
) -> Result<O, SdkError<E, Response>>
pub fn finalize_result( &mut self, result: Result<O, OrchestratorError<E>>, ) -> Result<O, SdkError<E, Response>>
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.
sourcepub fn fail(&mut self, error: OrchestratorError<E>)
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§
source§impl<I, O, E> Debug for InterceptorContext<I, O, E>
impl<I, O, E> Debug for InterceptorContext<I, O, E>
source§impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for AfterDeserializationInterceptorContextRef<'a, I, O, E>
impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for AfterDeserializationInterceptorContextRef<'a, I, O, E>
source§fn from(
inner: &'a InterceptorContext<I, O, E>,
) -> AfterDeserializationInterceptorContextRef<'a, I, O, E>
fn from( inner: &'a InterceptorContext<I, O, E>, ) -> AfterDeserializationInterceptorContextRef<'a, I, O, E>
source§impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for BeforeDeserializationInterceptorContextRef<'a, I, O, E>
impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for BeforeDeserializationInterceptorContextRef<'a, I, O, E>
source§fn from(
inner: &'a InterceptorContext<I, O, E>,
) -> BeforeDeserializationInterceptorContextRef<'a, I, O, E>
fn from( inner: &'a InterceptorContext<I, O, E>, ) -> BeforeDeserializationInterceptorContextRef<'a, I, O, E>
source§impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for BeforeSerializationInterceptorContextRef<'a, I, O, E>
impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for BeforeSerializationInterceptorContextRef<'a, I, O, E>
source§fn from(
inner: &'a InterceptorContext<I, O, E>,
) -> BeforeSerializationInterceptorContextRef<'a, I, O, E>
fn from( inner: &'a InterceptorContext<I, O, E>, ) -> BeforeSerializationInterceptorContextRef<'a, I, O, E>
source§impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for BeforeTransmitInterceptorContextRef<'a, I, O, E>
impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for BeforeTransmitInterceptorContextRef<'a, I, O, E>
source§fn from(
inner: &'a InterceptorContext<I, O, E>,
) -> BeforeTransmitInterceptorContextRef<'a, I, O, E>
fn from( inner: &'a InterceptorContext<I, O, E>, ) -> BeforeTransmitInterceptorContextRef<'a, I, O, E>
source§impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for FinalizerInterceptorContextRef<'a, I, O, E>
impl<'a, I, O, E> From<&'a InterceptorContext<I, O, E>> for FinalizerInterceptorContextRef<'a, I, O, E>
source§fn from(
inner: &'a InterceptorContext<I, O, E>,
) -> FinalizerInterceptorContextRef<'a, I, O, E>
fn from( inner: &'a InterceptorContext<I, O, E>, ) -> FinalizerInterceptorContextRef<'a, I, O, E>
source§impl<'a, I, O, E> From<&'a mut InterceptorContext<I, O, E>> for BeforeDeserializationInterceptorContextMut<'a, I, O, E>
impl<'a, I, O, E> From<&'a mut InterceptorContext<I, O, E>> for BeforeDeserializationInterceptorContextMut<'a, I, O, E>
source§fn from(
inner: &'a mut InterceptorContext<I, O, E>,
) -> BeforeDeserializationInterceptorContextMut<'a, I, O, E>
fn from( inner: &'a mut InterceptorContext<I, O, E>, ) -> BeforeDeserializationInterceptorContextMut<'a, I, O, E>
source§impl<'a, I, O, E> From<&'a mut InterceptorContext<I, O, E>> for BeforeSerializationInterceptorContextMut<'a, I, O, E>
impl<'a, I, O, E> From<&'a mut InterceptorContext<I, O, E>> for BeforeSerializationInterceptorContextMut<'a, I, O, E>
source§fn from(
inner: &'a mut InterceptorContext<I, O, E>,
) -> BeforeSerializationInterceptorContextMut<'a, I, O, E>
fn from( inner: &'a mut InterceptorContext<I, O, E>, ) -> BeforeSerializationInterceptorContextMut<'a, I, O, E>
source§impl<'a, I, O, E> From<&'a mut InterceptorContext<I, O, E>> for BeforeTransmitInterceptorContextMut<'a, I, O, E>
impl<'a, I, O, E> From<&'a mut InterceptorContext<I, O, E>> for BeforeTransmitInterceptorContextMut<'a, I, O, E>
source§fn from(
inner: &'a mut InterceptorContext<I, O, E>,
) -> BeforeTransmitInterceptorContextMut<'a, I, O, E>
fn from( inner: &'a mut InterceptorContext<I, O, E>, ) -> BeforeTransmitInterceptorContextMut<'a, I, O, E>
source§impl<'a, I, O, E> From<&'a mut InterceptorContext<I, O, E>> for FinalizerInterceptorContextMut<'a, I, O, E>
impl<'a, I, O, E> From<&'a mut InterceptorContext<I, O, E>> for FinalizerInterceptorContextMut<'a, I, O, E>
source§fn from(
inner: &'a mut InterceptorContext<I, O, E>,
) -> FinalizerInterceptorContextMut<'a, I, O, E>
fn from( inner: &'a mut InterceptorContext<I, O, E>, ) -> FinalizerInterceptorContextMut<'a, I, O, E>
Auto Trait Implementations§
impl<I = Input, O = Output, E = Error> !Freeze for InterceptorContext<I, O, E>
impl<I = Input, O = Output, E = Error> !RefUnwindSafe for InterceptorContext<I, O, E>
impl<I, O, E> Send for InterceptorContext<I, O, E>
impl<I, O, E> Sync for InterceptorContext<I, O, E>
impl<I, O, E> Unpin for InterceptorContext<I, O, E>
impl<I = Input, O = Output, E = Error> !UnwindSafe for InterceptorContext<I, O, E>
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
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);