Enum StreamMessage 

pub enum StreamMessage {
    Ready {
        protocol_version: String,
        scope: Scope,
        executions: Vec<String>,
        replayed: usize,
        truncated: bool,
        heartbeat_seconds: u64,
    },
    Heartbeat {
        at: String,
    },
    Lagged {
        dropped: u64,
    },
    Closing {
        reason: String,
    },
}

A message about the stream itself, rather than about an execution.

Same envelope as an event — a type and a data — so a client has one reader.

Variants

Ready

The first frame of every connection: what was subscribed to, what was replayed, and what the client should expect.

Fields

protocol_version: String

The event protocol this server speaks, PROTOCOL_VERSION.

scope: Scope

What this connection follows.

executions: Vec<String>

The executions followed, for a scoped connection.

replayed: usize

How many retained events were written before this connection went live, over every execution it follows.

truncated: bool

Whether the history before the replay had already been dropped by the store’s bound, for any execution followed, so a client knows its picture starts in the middle.

heartbeat_seconds: u64

How many seconds of quiet before the server pings.

Heartbeat

The channel is quiet and alive: written with the ping on every quiet heartbeat, as a text frame a page can see, so a client that has heard nothing for a few heartbeats knows the connection is dead and reconnects from its cursor.

Fields

at: String

When it was written, RFC 3339 in UTC.

Lagged

The client fell behind and events were dropped rather than buffered. It must read the snapshot and the history again, from the last sequence it saw.

Fields

dropped: u64

How many events were dropped.

Closing

The server is closing this connection.

Fields

reason: String

Why.

Trait Implementations

impl Clone for StreamMessage

fn clone(&self) -> StreamMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StreamMessage

impl JsonSchema for StreamMessage

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for StreamMessage

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for StreamMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamMessage