Skip to main content

JournalWriter

Struct JournalWriter 

pub struct JournalWriter { /* private fields */ }
Expand description

Append-only journal writer.

The writer stamps each event with monotonically increasing seq, a fresh event_id, mono_ns elapsed since mono_origin, the current wall-clock ts_utc, and the writer’s run_id.

Implementations§

§

impl JournalWriter

pub fn append( &mut self, event: EngineEvent, ) -> Result<EngineEvent, JournalError>

Append an event to the journal.

The writer overwrites the event’s seq, event_id, mono_ns, ts_utc, and run_id fields, then returns the finalized event.

pub fn stamp( &mut self, event: EngineEvent, ) -> Result<(EngineEvent, Vec<u8>), JournalError>

Stamp envelope fields, compute hash chain, and serialize to frame bytes.

Performs no disk I/O and does not mutate internal chain state. Returns (stamped_event, length_prefixed_frame_bytes).

pub fn write_frame(&mut self, frame: &[u8]) -> Result<(), JournalError>

Write pre-serialized frame bytes to the journal file.

Writes the frame and optionally fsyncs according to the configured FsyncPolicy.

pub fn sync(&mut self) -> Result<(), JournalError>

Explicitly fsync the journal file.

pub fn next_seq(&self) -> u64

Return the next sequence number that will be assigned.

pub fn run_id(&self) -> Uuid

Return the run ID.

pub fn path(&self) -> &Path

Return the journal file path.

pub fn fsync_policy(&self) -> FsyncPolicy

Return the configured fsync policy.

pub fn last_record_hash(&self) -> Option<&str>

Return the last record hash (for chain verification after close).

pub fn try_clone_file(&self) -> Result<File, JournalError>

Clone the underlying file descriptor.

Used by super::async_writer::AsyncJournalWriter to hand an independent fd to the background write thread.

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

§

fn into(self) -> U

Calls U::from(self).

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

§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. 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,

§

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