#[non_exhaustive]pub struct CodeCaptureConfiguration {
pub capture_arguments: Option<Vec<String>>,
pub capture_return: Option<bool>,
pub capture_stack_trace: Option<bool>,
pub capture_locals: Option<Vec<String>>,
pub capture_limits: Option<CaptureLimitsConfig>,
}Expand description
Defines what data to capture for code-level instrumentation, including arguments, return values, stack traces, local variables, and safety limits.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.capture_arguments: Option<Vec<String>>The function arguments to capture. Omit to capture defaults, use an empty list to capture none, use \["*"\] to capture all arguments, or specify argument names to capture selectively (up to 10 entries).
capture_return: Option<bool>Whether to capture the return value. Defaults to false.
capture_stack_trace: Option<bool>Whether to capture a stack trace when the instrumentation point is hit. Defaults to true.
capture_locals: Option<Vec<String>>The local variables to capture by name. Omit or pass an empty list to capture none. You can specify up to 20 names.
capture_limits: Option<CaptureLimitsConfig>Safety limits that bound what is captured, including hit counts, string length, collection depth, and stack trace size.
Implementations§
Source§impl CodeCaptureConfiguration
impl CodeCaptureConfiguration
Sourcepub fn capture_arguments(&self) -> &[String]
pub fn capture_arguments(&self) -> &[String]
The function arguments to capture. Omit to capture defaults, use an empty list to capture none, use \["*"\] to capture all arguments, or specify argument names to capture selectively (up to 10 entries).
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .capture_arguments.is_none().
Sourcepub fn capture_return(&self) -> Option<bool>
pub fn capture_return(&self) -> Option<bool>
Whether to capture the return value. Defaults to false.
Sourcepub fn capture_stack_trace(&self) -> Option<bool>
pub fn capture_stack_trace(&self) -> Option<bool>
Whether to capture a stack trace when the instrumentation point is hit. Defaults to true.
Sourcepub fn capture_locals(&self) -> &[String]
pub fn capture_locals(&self) -> &[String]
The local variables to capture by name. Omit or pass an empty list to capture none. You can specify up to 20 names.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .capture_locals.is_none().
Sourcepub fn capture_limits(&self) -> Option<&CaptureLimitsConfig>
pub fn capture_limits(&self) -> Option<&CaptureLimitsConfig>
Safety limits that bound what is captured, including hit counts, string length, collection depth, and stack trace size.
Source§impl CodeCaptureConfiguration
impl CodeCaptureConfiguration
Sourcepub fn builder() -> CodeCaptureConfigurationBuilder
pub fn builder() -> CodeCaptureConfigurationBuilder
Creates a new builder-style object to manufacture CodeCaptureConfiguration.
Trait Implementations§
Source§impl Clone for CodeCaptureConfiguration
impl Clone for CodeCaptureConfiguration
Source§fn clone(&self) -> CodeCaptureConfiguration
fn clone(&self) -> CodeCaptureConfiguration
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CodeCaptureConfiguration
impl Debug for CodeCaptureConfiguration
Source§impl PartialEq for CodeCaptureConfiguration
impl PartialEq for CodeCaptureConfiguration
impl StructuralPartialEq for CodeCaptureConfiguration
Auto Trait Implementations§
impl Freeze for CodeCaptureConfiguration
impl RefUnwindSafe for CodeCaptureConfiguration
impl Send for CodeCaptureConfiguration
impl Sync for CodeCaptureConfiguration
impl Unpin for CodeCaptureConfiguration
impl UnsafeUnpin for CodeCaptureConfiguration
impl UnwindSafe for CodeCaptureConfiguration
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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>
renamed to 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);