Skip to main content

StreamEvent

Struct StreamEvent 

Source
#[non_exhaustive]
pub struct StreamEvent { pub offset: i64, pub stream: String, pub key: Option<String>, pub payload: Vec<u8>, pub created_at: i64, }
Expand description

A stream event — honker’s shape with one rename (topic → stream, ADR-015 §3).

#[non_exhaustive] (ADR-017 §3). Offsets are positions in the stream’s log — immutable, never renumbered; order is global FIFO under publish sequence. The key is carried metadata only: not a partitioning instruction, not a dedup key, not an ordering key.

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.
§offset: i64

Position in the stream’s log; immutable.

§stream: String

The stream name.

§key: Option<String>

The carried key; None unless published keyed.

§payload: Vec<u8>

Payload bytes — the serde_json serialization of the trait Value at publish time (ADR-020 §4); decode with StreamEvent::payload_as.

§created_at: i64

Unix seconds at publish (the engines’ single clock source).

Implementations§

Source§

impl StreamEvent

Source

pub fn payload_as<T: DeserializeOwned>(&self) -> Result<T>

Decode the stored payload bytes into a concrete target type.

The stored bytes are the serde_json serialization of the publish-time Value (ADR-020 §4); any deserialization failure is Error::Codec.

Trait Implementations§

Source§

impl Clone for StreamEvent

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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
Source§

impl Eq for StreamEvent

Source§

impl PartialEq for StreamEvent

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StreamEvent

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.