Struct ProtocolReport 

pub struct ProtocolReport {
    pub protocol_version: String,
    pub websocket: String,
    pub subscription: Vec<ParameterView>,
    pub heartbeat_seconds: u64,
    pub max_connections: usize,
    pub max_replay: usize,
    pub event_types: Vec<String>,
    pub stream_types: Vec<String>,
    pub event_schema: Value,
    pub stream_schema: Value,
    pub limits: LimitsView,
}

The answer of executions.protocol: the live channel’s whole contract, derived from the types that implement it.

Fields

protocol_version: String

The version of the event protocol this server speaks.

websocket: String

Where the live channel is: a path on this same server, not a second daemon.

subscription: Vec<ParameterView>

How the subscription is expressed, and what a reconnect sends.

heartbeat_seconds: u64

How many seconds of quiet before the server pings.

max_connections: usize

How many live channels this process serves at once.

max_replay: usize

How many retained events a scoped connection replays before going live.

event_types: Vec<String>

The event types a client may receive, from the one enum that defines them.

stream_types: Vec<String>

The stream’s own control messages.

event_schema: Value

The JSON Schema of an event, derived from the Rust type.

stream_schema: Value

The JSON Schema of a control message, derived from the Rust type.

limits: LimitsView

What the store keeps, so a client knows what it may ask for.

Trait Implementations

impl Debug for ProtocolReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ProtocolReport

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 Serialize for ProtocolReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.