Skip to main content

SessionRecorder

Struct SessionRecorder 

Source
pub struct SessionRecorder<W> { /* private fields */ }
Expand description

Records session events to a JSONL output.

The recorder is thread-safe and can be used as an EventBus observer. It writes each event as a JSON line immediately for crash resilience.

§Example

use ralph_core::SessionRecorder;
use ralph_proto::Event;

let mut output = Vec::new();
let recorder = SessionRecorder::new(&mut output);

// Record a bus event
let event = Event::new("task.start", "Begin implementation");
recorder.record_bus_event(&event);

// Flush and check output
drop(recorder);
let output_str = String::from_utf8_lossy(&output);
assert!(output_str.contains("bus.publish"));

Implementations§

Source§

impl<W: Write> SessionRecorder<W>

Source

pub fn new(writer: W) -> Self

Creates a new session recorder writing to the given output.

Source

pub fn record_bus_event(&self, event: &Event)

Records an EventBus event.

Source

pub fn record_ux_event(&self, ux_event: &UxEvent)

Records a UX event.

Source

pub fn record_ux_events(&self, events: &[UxEvent])

Records multiple UX events.

Source

pub fn record_meta(&self, record: Record)

Records a metadata event.

Source

pub fn ux_write_count(&self) -> u32

Returns the number of UX write events recorded.

Source

pub fn elapsed(&self) -> Duration

Returns the elapsed time since recording started.

Source

pub fn flush(&self) -> Result<()>

Flushes the underlying writer.

Source§

impl<W: Write + Send + 'static> SessionRecorder<W>

Source

pub fn make_observer(recorder: Arc<Self>) -> impl Fn(&Event) + Send + 'static

Creates an observer closure suitable for EventBus::set_observer.

The returned closure holds a reference to this recorder and calls record_bus_event for each event received.

§Example
let recorder = Arc::new(SessionRecorder::new(file));
let observer = SessionRecorder::make_observer(Arc::clone(&recorder));
event_bus.set_observer(observer);

Auto Trait Implementations§

§

impl<W> !Freeze for SessionRecorder<W>

§

impl<W> RefUnwindSafe for SessionRecorder<W>

§

impl<W> Send for SessionRecorder<W>
where W: Send,

§

impl<W> Sync for SessionRecorder<W>
where W: Send,

§

impl<W> Unpin for SessionRecorder<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for SessionRecorder<W>
where W: UnsafeUnpin,

§

impl<W> UnwindSafe for SessionRecorder<W>

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> 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, 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