Enum WsServerMessage 

pub enum WsServerMessage {
    Output {
        data: String,
        is_final: bool,
    },
    Result {
        success: bool,
        exit_code: Option<i32>,
        duration_ms: u64,
        timed_out: bool,
        total_bytes: u64,
    },
    Error {
        code: String,
        message: String,
    },
    Ping,
    Pong,
}

A message the server sends to a WebSocket client.

Deliberately not deny_unknown_fields: this is the type a consumer deserialises the server’s output with, and a new field on a later server must not make an older consumer reject the whole message. The strictness that fixes silently-dropped input belongs on WsClientMessage only.

Variants

Output

One chunk of a running command’s output.

Fields

data: String

is_final: bool

Whether this is the final chunk.

Result

Terminal result of an execution.

Carries total_bytes but not truncated, unlike the REST response: every chunk reaches a streaming consumer as it arrives, so there is nothing here for a cap to discard. The figure is what a consumer needs to confirm it received the whole stream.

Fields

success: bool

exit_code: Option<i32>

duration_ms: u64

timed_out: bool

total_bytes: u64

Error

Error message.

Fields

code: String

message: String

Ping

Connection health.

Pong

Trait Implementations

impl Clone for WsServerMessage

fn clone(&self) -> WsServerMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsServerMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WsServerMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WsServerMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.