pub struct FinalizerInterceptorContextMut<'a, I = Input, O = Output, E = Error> { /* private fields */ }Expand description
Interceptor context for finalization hooks.
This context is used by the modify_before_attempt_completion and modify_before_completion hooks
that are all called upon both success and failure, and may have varying levels
of context available depending on where a failure occurred if the operation failed.
Implementations§
Source§impl<'a, I, O, E> FinalizerInterceptorContextMut<'a, I, O, E>
impl<'a, I, O, E> FinalizerInterceptorContextMut<'a, I, O, E>
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 operation output or error.
Sourcepub fn request_mut(&mut self) -> Option<&mut Request>
pub fn request_mut(&mut self) -> Option<&mut Request>
Mutably returns the serialized request.
Sourcepub fn response_mut(&mut self) -> Option<&mut Response>
pub fn response_mut(&mut self) -> Option<&mut Response>
Mutably returns the raw response.
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>>>
Mutably returns the deserialized operation output or error.
Sourcepub fn inner(&self) -> &InterceptorContext<I, O, E>
pub fn inner(&self) -> &InterceptorContext<I, O, E>
Downgrade this wrapper struct, returning the underlying InterceptorContext.
There’s no good reason to use this unless you’re writing tests or you have to interact with an API that doesn’t support the context wrapper structs.
Sourcepub fn inner_mut(&mut self) -> &mut InterceptorContext<I, O, E>
pub fn inner_mut(&mut self) -> &mut InterceptorContext<I, O, E>
Downgrade this wrapper struct, returning the underlying InterceptorContext.
There’s no good reason to use this unless you’re writing tests or you have to interact with an API that doesn’t support the context wrapper structs.
Trait Implementations§
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<'a, I, O, E> Freeze for FinalizerInterceptorContextMut<'a, I, O, E>
impl<'a, I = Input, O = Output, E = Error> !RefUnwindSafe for FinalizerInterceptorContextMut<'a, I, O, E>
impl<'a, I, O, E> Send for FinalizerInterceptorContextMut<'a, I, O, E>
impl<'a, I, O, E> Sync for FinalizerInterceptorContextMut<'a, I, O, E>
impl<'a, I, O, E> Unpin for FinalizerInterceptorContextMut<'a, I, O, E>
impl<'a, I = Input, O = Output, E = Error> !UnwindSafe for FinalizerInterceptorContextMut<'a, 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
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§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();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());Source§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();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());Source§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();Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());Source§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();Source§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.Source§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);