pub struct ReplayEngine { /* private fields */ }Expand description
The main replay controller — provides step-by-step playback of an execution trace.
Implementations§
Source§impl ReplayEngine
impl ReplayEngine
Sourcepub fn new(trace: ExecutionTrace) -> Self
pub fn new(trace: ExecutionTrace) -> Self
Create a new replay from an execution trace.
Sourcepub fn from_store(
store: &AuditStore,
trace_id: Uuid,
) -> Result<Self, ReplayError>
pub fn from_store( store: &AuditStore, trace_id: Uuid, ) -> Result<Self, ReplayError>
Create a replay engine from a trace in the audit store.
Sourcepub fn total_events(&self) -> usize
pub fn total_events(&self) -> usize
Get total number of events.
Sourcepub fn is_at_start(&self) -> bool
pub fn is_at_start(&self) -> bool
Is the replay at the beginning?
Sourcepub fn step_forward(&mut self) -> Option<&TraceEvent>
pub fn step_forward(&mut self) -> Option<&TraceEvent>
Step forward one event. Returns the event at the new position, or
None if already at the end.
Sourcepub fn step_backward(&mut self) -> Option<&TraceEvent>
pub fn step_backward(&mut self) -> Option<&TraceEvent>
Step backward one event. Returns the event at the new position, or
None if already at the start.
Sourcepub fn seek(&mut self, position: usize) -> Result<&TraceEvent, ReplayError>
pub fn seek(&mut self, position: usize) -> Result<&TraceEvent, ReplayError>
Jump to a specific position.
Sourcepub fn fast_forward(&mut self)
pub fn fast_forward(&mut self)
Go to the end.
Sourcepub fn current_event(&self) -> Option<&TraceEvent>
pub fn current_event(&self) -> Option<&TraceEvent>
Get the current event.
Sourcepub fn snapshot(&self) -> ReplaySnapshot
pub fn snapshot(&self) -> ReplaySnapshot
Get a snapshot of the current replay state.
Sourcepub fn describe_current(&self) -> String
pub fn describe_current(&self) -> String
Get the current step as a formatted description.
Sourcepub fn timeline(&self) -> Vec<TimelineEntry>
pub fn timeline(&self) -> Vec<TimelineEntry>
Get a full timeline description of all events.
Sourcepub fn add_bookmark(&mut self, label: impl Into<String>)
pub fn add_bookmark(&mut self, label: impl Into<String>)
Add a bookmark at the current position.
Sourcepub fn goto_bookmark(
&mut self,
index: usize,
) -> Result<&TraceEvent, ReplayError>
pub fn goto_bookmark( &mut self, index: usize, ) -> Result<&TraceEvent, ReplayError>
Jump to a bookmark by index.
Sourcepub fn trace(&self) -> &ExecutionTrace
pub fn trace(&self) -> &ExecutionTrace
Get the trace being replayed.
Sourcepub fn skip_to_next_tool_event(&mut self) -> Option<&TraceEvent>
pub fn skip_to_next_tool_event(&mut self) -> Option<&TraceEvent>
Skip forward to the next event of a tool-related kind
(ToolRequested, ToolApproved, ToolDenied, or ToolExecuted).
Sourcepub fn cumulative_usage(&self) -> TokenUsage
pub fn cumulative_usage(&self) -> TokenUsage
Get cumulative token usage up to and including the current position.
Sourcepub fn cumulative_cost(&self) -> CostEstimate
pub fn cumulative_cost(&self) -> CostEstimate
Get cumulative cost up to and including the current position.
The per-call cost is split proportionally between input and output based on token counts.
Auto Trait Implementations§
impl Freeze for ReplayEngine
impl RefUnwindSafe for ReplayEngine
impl Send for ReplayEngine
impl Sync for ReplayEngine
impl Unpin for ReplayEngine
impl UnsafeUnpin for ReplayEngine
impl UnwindSafe for ReplayEngine
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> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for 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>
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>
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);