Sprites.Protocol (Sprites v0.2.0)

Binary protocol encoding/decoding for Sprites WebSocket.

Non-TTY Mode Protocol

Each message has a stream ID as the first byte:

decoded()

stream_type()

decode(data)

Decodes a binary message from the WebSocket.

Encodes stdin data for sending.

Encodes the stdin EOF signal.

exit_id()

stderr_id()

stdin_eof_id()

stdin_id()

Returns the stream ID constants.

stdout_id()

@type decoded() :: {stream_type(), binary() | integer() | nil}

@type stream_type() :: :stdin | :stdout | :stderr | :exit | :stdin_eof | :unknown

@spec decode(binary()) :: decoded()

Decodes a binary message from the WebSocket.

Returns a tuple of {stream_type, payload} where:

{:stdout, binary} - stdout data
{:stderr, binary} - stderr data
{:exit, integer} - first payload byte as the exit code (defaults to 0 when omitted)
{:stdin_eof, nil} - stdin closed
{:unknown, binary} - unrecognized data

@spec encode_stdin(iodata(), boolean()) :: binary()

Encodes stdin data for sending.

In TTY mode, data is sent as raw binary. In non-TTY mode, data is prefixed with the stdin stream ID.

@spec encode_stdin_eof() :: binary()