Skip to main content

EventStream

Struct EventStream 

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

Event Stream aggregate enforcing gapless version numbers

Inspired by SierraDB’s watermark pattern for consistent event sourcing. Ensures no gaps in version sequences, critical for proper event replay.

§SierraDB Pattern

  • Watermark tracks “highest continuously confirmed sequence”
  • Prevents gaps that would break event sourcing guarantees
  • Uses optimistic locking for concurrency control

§Invariants

  • Versions start at 1 and increment sequentially
  • No gaps allowed in version sequence
  • Watermark <= max version always
  • All versions below watermark are confirmed (gapless)

Implementations§

Source§

impl EventStream

Source

pub fn new(stream_id: EntityId) -> Self

Create a new event stream

Source

pub fn reconstruct( stream_id: EntityId, partition_key: PartitionKey, current_version: u64, watermark: u64, events: Vec<Event>, expected_version: Option<u64>, created_at: DateTime<Utc>, updated_at: DateTime<Utc>, ) -> Result<Self>

Reconstruct an EventStream from persistent storage

Used by repository implementations to restore streams from database. Bypasses validation since data is already validated at creation time.

§Arguments
  • stream_id: Entity ID of the stream
  • partition_key: Pre-computed partition assignment
  • current_version: Latest version number
  • watermark: Highest continuously confirmed version
  • events: All events in the stream
  • expected_version: Optional optimistic lock version
  • created_at: Stream creation timestamp
  • updated_at: Last modification timestamp
Source

pub fn append_event(&mut self, event: Event) -> Result<u64>

Append an event with optimistic locking

§SierraDB Pattern
  • Checks expected_version matches current_version
  • Prevents concurrent modification conflicts
  • Ensures gapless version sequence
Source

pub fn expect_version(&mut self, version: u64)

Set expected version for next append (optimistic locking)

Source

pub fn clear_expected_version(&mut self)

Clear expected version

Source

pub fn events_from(&self, from_version: u64) -> Vec<&Event>

Get events from version (inclusive)

Source

pub fn is_gapless(&self) -> bool

Check if stream has gapless versions up to watermark

Source

pub fn stream_id(&self) -> &EntityId

Source

pub fn partition_key(&self) -> &PartitionKey

Source

pub fn current_version(&self) -> u64

Source

pub fn watermark(&self) -> u64

Source

pub fn event_count(&self) -> usize

Source

pub fn created_at(&self) -> DateTime<Utc>

Source

pub fn updated_at(&self) -> DateTime<Utc>

Source

pub fn expected_version(&self) -> Option<u64>

Source

pub fn tenant_id(&self) -> Option<&TenantId>

Get the tenant ID for this stream

Returns the tenant_id from the first event, or None if the stream is empty. All events in a stream should belong to the same tenant.

Source

pub fn has_consistent_tenant(&self) -> bool

Validate that all events in the stream belong to the same tenant

Returns true if the stream is empty or all events have the same tenant_id. This is a safety check to detect tenant isolation violations.

Source

pub fn validate_event_tenant(&self, event: &Event) -> Result<()>

Validate that an event belongs to this stream’s tenant

Returns an error if:

  • The stream has events and the new event’s tenant doesn’t match

This ensures tenant isolation at the stream level.

Source

pub fn append_event_with_tenant_check(&mut self, event: Event) -> Result<u64>

Append an event with tenant validation

Like append_event, but also validates tenant consistency. Prevents cross-tenant event appends for security.

Trait Implementations§

Source§

impl Clone for EventStream

Source§

fn clone(&self) -> EventStream

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EventStream

Source§

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

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

impl<'de> Deserialize<'de> for EventStream

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for EventStream

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,