Skip to main content

EventRecorder

Struct EventRecorder 

Source
pub struct EventRecorder { /* private fields */ }
Expand description

Thread-safe session recorder for time-travel debugging. Records events and state checkpoints during a recording session. Only one session can be active at a time.

Implementations§

Source§

impl EventRecorder

Source

pub fn new(max_events: usize) -> Self

Creates a new recorder with the given maximum event capacity.

use victauri_core::EventRecorder;

let recorder = EventRecorder::new(1000);
assert!(!recorder.is_recording());
assert_eq!(recorder.event_count(), 0);
Source

pub fn start(&self, session_id: String) -> Result<()>

Starts a new recording session; returns Err if one is already active.

§Errors

Returns VictauriError::RecordingAlreadyActive if a session is already in progress.

§Examples
use victauri_core::EventRecorder;

let recorder = EventRecorder::new(1000);
recorder.start("session-1".to_string()).unwrap();
assert!(recorder.is_recording());
Source

pub fn stop(&self) -> Option<RecordedSession>

Stops the active recording and returns the completed session, or None if not recording.

§Examples
use victauri_core::EventRecorder;

let recorder = EventRecorder::new(1000);
recorder.start("session-1".to_string()).unwrap();
let session = recorder.stop().expect("should return session");
assert_eq!(session.id, "session-1");
assert!(!recorder.is_recording());
Source

pub fn is_recording(&self) -> bool

Returns true if a recording session is currently active.

Source

pub fn record_event(&self, event: AppEvent)

Appends an event to the active recording, evicting the oldest if at capacity.

Source

pub fn checkpoint( &self, id: String, label: Option<String>, state: Value, ) -> Result<()>

Creates a named state checkpoint at the current event index; returns Err if not recording.

§Errors

Returns VictauriError::NoActiveRecording if no session is in progress.

Source

pub fn event_count(&self) -> usize

Returns the number of events recorded so far, or 0 if not recording.

Source

pub fn checkpoint_count(&self) -> usize

Returns the number of checkpoints created so far, or 0 if not recording.

Source

pub fn events_since(&self, index: usize) -> Vec<RecordedEvent>

Returns all events with an index >= the given value.

Source

pub fn events_between( &self, from: DateTime<Utc>, to: DateTime<Utc>, ) -> Vec<RecordedEvent>

Returns events whose timestamps fall within the given inclusive range.

Source

pub fn get_checkpoints(&self) -> Vec<StateCheckpoint>

Returns all checkpoints from the active recording session.

Source

pub fn events_between_checkpoints( &self, from_checkpoint_id: &str, to_checkpoint_id: &str, ) -> Result<Vec<RecordedEvent>>

Returns events recorded between two named checkpoints.

§Errors
Source

pub fn export(&self) -> Option<RecordedSession>

Snapshot the current recording as a session WITHOUT stopping it.

Source

pub fn import(&self, session: RecordedSession)

Import a previously exported session, replacing any active recording.

Source

pub fn ipc_replay_sequence(&self) -> Vec<IpcCall>

Extracts IPC calls in order from the recording for replay.

Trait Implementations§

Source§

impl Clone for EventRecorder

Source§

fn clone(&self) -> EventRecorder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for EventRecorder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for EventRecorder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more