Skip to main content

Event

Struct Event 

Source
pub struct Event {
    pub event_id: Uuid,
    pub partition_key: Uuid,
    pub partition_id: u16,
    pub transaction_id: Uuid,
    pub partition_sequence: u64,
    pub stream_version: u64,
    pub timestamp: SystemTime,
    pub stream_id: String,
    pub event_name: String,
    pub metadata: Vec<u8>,
    pub payload: Vec<u8>,
}
Expand description

Represents a single event record in the event store.

Fields§

§event_id: Uuid

Globally unique identifier for this specific event. Generated once when the event is created and never changes.

§partition_key: Uuid

Determines which partition this event belongs to.

This is typically a domain-significant identifier (like customer ID, tenant ID) that groups related events together. All events for the same stream must share the same partition key.

§partition_id: u16

The numeric partition identifier (0-1023) derived from the partition_key.

Events with the same partition_id have a guaranteed total ordering defined by their partition_sequence, regardless of which stream they belong to.

§transaction_id: Uuid

Identifier for multi-event transactions.

When multiple events are saved as part of a single transaction, they share this identifier. For events not part of a transaction, this may be a null UUID.

§partition_sequence: u64

The monotonic, gapless sequence number within the partition.

This defines the total ordering of events within a partition. Each new event in a partition receives a sequence number exactly one higher than the previous event.

§stream_version: u64

The version number of the entity/aggregate after this event is applied.

This is a monotonic, gapless counter specific to the stream. It starts at 0 and increments by 1 for each event in the stream. Used for optimistic concurrency control and to determine the current state version of an entity.

§timestamp: SystemTime

Unix timestamp (in milliseconds) when the event was created.

Useful for time-based queries and analysis, though not used for event ordering.

§stream_id: String

Identifier for the stream (entity/aggregate) this event belongs to.

Typically corresponds to a domain entity ID, like “account-123” or “order-456”. All events for the same entity share the same stream_id.

§event_name: String

Name of the event type, used for deserialization and event handling.

Examples: “AccountCreated”, “OrderShipped”, “PaymentRefunded”. Should be meaningful in the domain context.

§metadata: Vec<u8>

Additional system or application metadata about the event.

May include information like user ID, correlation IDs, causation IDs, or other contextual data not part of the event payload itself.

§payload: Vec<u8>

The actual event data serialized as bytes.

Contains the domain-specific information that constitutes the event. Must be deserializable based on the event_name.

Implementations§

Source§

impl Event

Source

pub fn sequence_or_version_for_stream(&self) -> u64

Get the sequence/version number to use for acknowledgment.

For stream subscriptions, this returns the stream_version. For partition subscriptions, this returns the partition_sequence. Use this value with acknowledge_events() to acknowledge this event.

Source

pub fn sequence_for_partition(&self) -> u64

Get the sequence number to use for partition subscription acknowledgment.

Use this value with acknowledge_events() when acknowledging events from a partition subscription.

Source

pub fn version_for_stream(&self) -> u64

Get the version number to use for stream subscription acknowledgment.

Use this value with acknowledge_events() when acknowledging events from a stream subscription.

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Event

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 Event

Source§

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

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

impl<'de> Deserialize<'de> for Event

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 FromRedisValue for Event

Source§

fn from_redis_value(value: &Value) -> RedisResult<Self>

Given a redis Value this attempts to convert it into the given destination type. If that fails because it’s not compatible an appropriate error is generated.
Source§

fn from_owned_redis_value(v: Value) -> Result<Self, RedisError>

Given a redis Value this attempts to convert it into the given destination type. If that fails because it’s not compatible an appropriate error is generated.
Source§

fn from_redis_values(items: &[Value]) -> Result<Vec<Self>, RedisError>

Similar to from_redis_value but constructs a vector of objects from another vector of values. This primarily exists internally to customize the behavior for vectors of tuples.
Source§

fn from_owned_redis_values(items: Vec<Value>) -> Result<Vec<Self>, RedisError>

The same as from_redis_values, but takes a Vec<Value> instead of a &[Value].
Source§

fn from_each_owned_redis_values( items: Vec<Value>, ) -> Vec<Result<Self, RedisError>>

The same as from_owned_redis_values, but returns a result for each conversion to make handling them case-by-case possible.
Source§

fn from_byte_vec(_vec: &[u8]) -> Option<Vec<Self>>

Convert bytes to a single element vector.
Source§

fn from_owned_byte_vec(_vec: Vec<u8>) -> Result<Vec<Self>, RedisError>

Convert bytes to a single element vector.
Source§

impl PartialEq for Event

Source§

fn eq(&self, other: &Event) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Event

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

impl Eq for Event

Source§

impl StructuralPartialEq for Event

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

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> 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> 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,