pub enum FailureContext {
Vm {
span: SpanId,
event_seq: EventSeq,
call_stack: Vec<StackFrame>,
buffer_tail: String,
vars_in_scope: Vec<(String, String)>,
},
Pure {
span: SpanId,
event_seq: EventSeq,
call_stack: Vec<StackFrame>,
vars_in_scope: Vec<(String, String)>,
},
PreVm {
span: Option<SpanId>,
call_stack: Vec<StackFrame>,
},
}Expand description
Diagnostic context captured at failure-construction time. Travels with
every Failure so that downstream consumers (structured-log artifact,
console error renderer) can render the call site, what arrived in the
shell, and which user vars were live - without needing to reach back
into a VM that is about to be dropped.
The variant makes the failure’s provenance explicit. Vm carries the
full diagnostic picture; PreVm represents failures raised outside any
VM (effect resolution, shell-block lookup, cleanup-shell spawn,
pre-init PTY spawn) and carries only the surrounding span, when one is
known. The structured-log builder flattens both variants into a single
on-disk shape via the accessor methods.
Variants§
Vm
Captured by a running VM at failure-construction time.
Fields
call_stack: Vec<StackFrame>Pure
Failure raised from pure evaluation at a pre-VM boundary (test/effect
preamble, overlay, or a pure-fn body reached from one). Unlike
PreVm, a pure-match failure always emitted its event trio and knows
its scope vars, so event_seq and vars_in_scope are non-optional
and real. No buffer (a pure match reads no shell).
Fields
call_stack: Vec<StackFrame>PreVm
Failure raised before/around any VM. span points at the
surrounding span when one is known (effect-setup span,
shell-block span, cleanup-block span), None otherwise. The
call_stack carries pure-fn frames when the failure came out of
pure evaluation; empty for every other pre-VM failure.
Implementations§
Source§impl FailureContext
impl FailureContext
Sourcepub fn pre_vm_with_span(span: SpanId) -> Self
pub fn pre_vm_with_span(span: SpanId) -> Self
Construct a PreVm context tied to a known surrounding span.
Sourcepub fn pre_vm_with_frames(
span: Option<SpanId>,
call_stack: Vec<StackFrame>,
) -> Self
pub fn pre_vm_with_frames( span: Option<SpanId>, call_stack: Vec<StackFrame>, ) -> Self
Construct a PreVm context tied to a known surrounding span and a
resolved call stack (pure-fn frames).
Sourcepub fn pure(
span: SpanId,
event_seq: EventSeq,
call_stack: Vec<StackFrame>,
vars_in_scope: Vec<(String, String)>,
) -> Self
pub fn pure( span: SpanId, event_seq: EventSeq, call_stack: Vec<StackFrame>, vars_in_scope: Vec<(String, String)>, ) -> Self
Construct a Pure context for a pre-VM pure-evaluation failure.
pub fn span(&self) -> Option<SpanId>
pub fn event_seq(&self) -> Option<EventSeq>
pub fn call_stack(&self) -> &[StackFrame]
pub fn buffer_tail(&self) -> &str
pub fn vars_in_scope(&self) -> &[(String, String)]
Trait Implementations§
Source§impl Clone for FailureContext
impl Clone for FailureContext
Source§fn clone(&self) -> FailureContext
fn clone(&self) -> FailureContext
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for FailureContext
impl RefUnwindSafe for FailureContext
impl Send for FailureContext
impl Sync for FailureContext
impl Unpin for FailureContext
impl UnsafeUnpin for FailureContext
impl UnwindSafe for FailureContext
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§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);