Skip to main content

RecordingWriter

Struct RecordingWriter 

Source
pub struct RecordingWriter<W: Write> { /* private fields */ }
Expand description

Writes a compact binary recording: a version header, then length-framed events with fixed little-endian numbers, optional-id flags and UTF-8 symbols. Version 2 retains resting order participant and placement metadata. No runtime or filesystem policy is imposed; a host can use a buffered file on native targets or bytes in a browser.

Implementations§

Source§

impl<W: Write> RecordingWriter<W>

Source

pub fn new(writer: W) -> Result<Self>

Writes the version header to a new recording.

Source

pub fn write(&mut self, event: &ReplayEvent) -> Result<()>

Appends an event without flushing the underlying stream. Invalid data writes nothing.

Source

pub fn capture( &mut self, events: impl IntoIterator<Item = Result<ReplayEvent>>, ) -> Result<()>

Records a host event stream until it ends or either reading or writing fails. The first error is returned unchanged; previously written complete events remain in the stream. Run blocking streams outside the UI thread and call Self::finish to flush storage.

Source

pub fn get_ref(&self) -> &W

Borrows the underlying writer without flushing buffered storage.

Source

pub fn finish(self) -> Result<W>

Flushes and returns the underlying writer. Propagates disk and stream errors.

Auto Trait Implementations§

§

impl<W> Freeze for RecordingWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for RecordingWriter<W>
where W: RefUnwindSafe,

§

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

§

impl<W> Sync for RecordingWriter<W>
where W: Sync,

§

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

§

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

§

impl<W> UnwindSafe for RecordingWriter<W>
where W: UnwindSafe,

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> MaybeSend for T
where T: Send + Sync + ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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.