Skip to main content

StreamEvent

Struct StreamEvent 

Source
#[non_exhaustive]
pub struct StreamEvent { pub family: StreamFamily, pub cursor: StreamCursor, pub execution_id: Option<ExecutionId>, pub attempt_index: Option<u32>, pub timestamp: TimestampMs, pub payload: Bytes, }
Expand description

Per-event payload.

  • family identifies the event shape.
  • cursor is the position this event occupies in the stream; consumers persist it + hand it back on reconnect so replay begins strictly after this event.
  • execution_id, attempt_index, timestamp are inline hot fields (RFC-019 §Open Questions #4, owner-adjudicated inline) so common consumers do not need a follow-up describe_execution RPC.
  • payload is the family-specific binary event body. Schema is the backend’s (not stabilised in Stage A — consumers parse via family-specific helpers Stage B will ship).

#[non_exhaustive] so future inline metadata (e.g. namespace) adds without a breaking change.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§family: StreamFamily§cursor: StreamCursor§execution_id: Option<ExecutionId>§attempt_index: Option<u32>§timestamp: TimestampMs§payload: Bytes

Implementations§

Source§

impl StreamEvent

Source

pub fn new( family: StreamFamily, cursor: StreamCursor, timestamp: TimestampMs, payload: Bytes, ) -> Self

Construct a minimal StreamEvent. The struct is #[non_exhaustive] so external crates cannot build via a literal — backends go through this constructor + builder. Optional inline metadata is added via with_execution_id / with_attempt_index so call-site shape stays stable across future field additions.

Source

pub fn with_execution_id(self, id: ExecutionId) -> Self

Source

pub fn with_attempt_index(self, idx: u32) -> Self

Trait Implementations§

Source§

impl Clone for StreamEvent

Source§

fn clone(&self) -> StreamEvent

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 StreamEvent

Source§

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

Formats the value using the given formatter. 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, 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.