pub struct EventLog { /* private fields */ }Expand description
Append-only event log backed by a LanceDB dataset.
Thread-safe: the atomic seq counter ensures gap-free sequence numbers from a single writer. For multi-writer (Raft), the leader assigns seqs.
Implementations§
Source§impl EventLog
impl EventLog
Sourcepub async fn open(storage: Arc<dyn PhysicalStore>) -> HirnResult<Self>
pub async fn open(storage: Arc<dyn PhysicalStore>) -> HirnResult<Self>
Create a new event log on the given storage backend.
Scans the existing events dataset (if any) to recover the next
sequence number, ensuring gap-free continuation after restart.
Sourcepub fn subscribe(&self) -> Receiver<EventEnvelope>
pub fn subscribe(&self) -> Receiver<EventEnvelope>
Get a broadcast receiver for real-time event subscriptions.
Sourcepub fn subscribe_filtered(&self, filter: EventFilter) -> Receiver<EventEnvelope>
pub fn subscribe_filtered(&self, filter: EventFilter) -> Receiver<EventEnvelope>
Get a filtered receiver that only delivers events matching the filter.
Spawns a background task that reads from the broadcast channel and
forwards matching events to the returned mpsc::Receiver. The task
terminates when the receiver is dropped or the broadcast sender is
closed.
Sourcepub fn next_seq(&self) -> u64
pub fn next_seq(&self) -> u64
Current next sequence number (the number of events appended so far, if no compaction has occurred).
Sourcepub async fn append(
&self,
realm: impl Into<String>,
namespace: impl Into<String>,
agent_id: impl Into<String>,
event: MemoryEvent,
) -> HirnResult<EventEnvelope>
pub async fn append( &self, realm: impl Into<String>, namespace: impl Into<String>, agent_id: impl Into<String>, event: MemoryEvent, ) -> HirnResult<EventEnvelope>
Append a single event to the log.
Assigns a monotonic seq number, writes to LanceDB, and broadcasts to real-time subscribers.
Sourcepub async fn append_signed(
&self,
event: MemoryEvent,
realm: impl Into<String>,
namespace: impl Into<String>,
agent_id: impl Into<String>,
secret: &[u8],
) -> HirnResult<EventEnvelope>
pub async fn append_signed( &self, event: MemoryEvent, realm: impl Into<String>, namespace: impl Into<String>, agent_id: impl Into<String>, secret: &[u8], ) -> HirnResult<EventEnvelope>
Append a single event with HMAC signing.
Same as Self::append but signs the event envelope with the provided secret
before persisting it. Auditors can later call Self::verify_integrity to
confirm no events have been tampered with.
Sourcepub async fn append_batch(
&self,
realm: &str,
namespace: &str,
agent_id: &str,
events_in: Vec<MemoryEvent>,
) -> HirnResult<Vec<EventEnvelope>>
pub async fn append_batch( &self, realm: &str, namespace: &str, agent_id: &str, events_in: Vec<MemoryEvent>, ) -> HirnResult<Vec<EventEnvelope>>
Append a batch of events atomically.
All events get consecutive seq numbers.
Sourcepub async fn read(
&self,
from_seq: u64,
to_seq: u64,
) -> HirnResult<Vec<EventEnvelope>>
pub async fn read( &self, from_seq: u64, to_seq: u64, ) -> HirnResult<Vec<EventEnvelope>>
Read events in a sequence range [from_seq, to_seq] inclusive.
Sourcepub async fn tail(&self, from_seq: u64) -> HirnResult<Vec<EventEnvelope>>
pub async fn tail(&self, from_seq: u64) -> HirnResult<Vec<EventEnvelope>>
Read all events from a sequence number onward.
Sourcepub async fn read_all(&self) -> HirnResult<Vec<EventEnvelope>>
pub async fn read_all(&self) -> HirnResult<Vec<EventEnvelope>>
Read all events matching an optional filter.
Sourcepub async fn read_with_filter(
&self,
filter: &EventFilter,
) -> HirnResult<Vec<EventEnvelope>>
pub async fn read_with_filter( &self, filter: &EventFilter, ) -> HirnResult<Vec<EventEnvelope>>
Read events with an advanced filter.
Sourcepub async fn replay<F>(&self, handler: F) -> HirnResult<u64>
pub async fn replay<F>(&self, handler: F) -> HirnResult<u64>
Replay all events through a handler function to reconstruct state.
Events are read in seq order and passed one-by-one to handler.
Sourcepub async fn verify_integrity(&self, secret: &[u8]) -> HirnResult<Vec<u64>>
pub async fn verify_integrity(&self, secret: &[u8]) -> HirnResult<Vec<u64>>
Verify HMAC integrity of all events in the log.
Returns the sequence numbers of events whose HMAC validation failed (missing HMAC or tampered data). An empty vec means all events are valid. Intended for use by external auditors.
Sourcepub async fn replay_from<F>(&self, from_seq: u64, handler: F) -> HirnResult<u64>
pub async fn replay_from<F>(&self, from_seq: u64, handler: F) -> HirnResult<u64>
Replay events from a specific seq onward.
Sourcepub async fn snapshot(
&self,
materialized_tables: &[&str],
) -> HirnResult<SnapshotMeta>
pub async fn snapshot( &self, materialized_tables: &[&str], ) -> HirnResult<SnapshotMeta>
Take a snapshot at the current seq, creating LanceDB tags on materialized tables.
Returns the snapshot metadata including the seq at which it was taken.
Sourcepub async fn compact(&self, before_seq: u64) -> HirnResult<CompactionResult>
pub async fn compact(&self, before_seq: u64) -> HirnResult<CompactionResult>
Compact (prune) events before the given sequence number.
Events with seq < before_seq are deleted from the events dataset.
Call optimize afterward to reclaim storage.
Sourcepub async fn apply_retention(
&self,
policy: &RetentionPolicy,
) -> HirnResult<CompactionResult>
pub async fn apply_retention( &self, policy: &RetentionPolicy, ) -> HirnResult<CompactionResult>
Apply a retention policy to compact old events.
Auto Trait Implementations§
impl !Freeze for EventLog
impl !RefUnwindSafe for EventLog
impl Send for EventLog
impl Sync for EventLog
impl Unpin for EventLog
impl UnsafeUnpin for EventLog
impl !UnwindSafe for EventLog
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>, which can then be
downcast into Box<dyn 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>, which 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> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.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> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.