lightspeed/protocol

Versioned protocol frame model.

Types

DecodeError

Protocol decode errors.

pub type DecodeError {
  EmptyFrame
  UnknownFrameTag(String)
  BadFieldCount(tag: String, expected: Int, actual: Int)
  InvalidVersion(String)
  UnsupportedVersion(Int)
  UnsupportedProtocol(String)
  InvalidEscapeSequence
}

Constructors

```
EmptyFrame
```
```
UnknownFrameTag(String)
```

BadFieldCount(tag: String, expected: Int, actual: Int)

```
InvalidVersion(String)
```
```
UnsupportedVersion(Int)
```
```
UnsupportedProtocol(String)
```
```
InvalidEscapeSequence
```

Frame

Protocol frame exchanged between client and server.

pub type Frame {
  Hello(protocol: String, version: Int)
  Event(ref: String, name: String, payload: String)
  Diff(ref: String, html: String)
  Ack(ref: String)
  Failure(ref: String, reason: String)
}

Constructors

```
Hello(protocol: String, version: Int)
```

Event(ref: String, name: String, payload: String)

```
Diff(ref: String, html: String)
```
```
Ack(ref: String)
```
```
Failure(ref: String, reason: String)
```

Values

decode

pub fn decode(payload: String) -> Result(Frame, DecodeError)

Decode a textual frame payload.

decode_error_to_string

pub fn decode_error_to_string(error: DecodeError) -> String

Convert decode errors to stable strings for logs and adapter errors.

encode

pub fn encode(frame: Frame) -> String

Encode a frame into a transport-safe textual format.

hello

pub fn hello() -> Frame

Construct a protocol hello frame.

is_current_hello

pub fn is_current_hello(frame: Frame) -> Bool

True when the frame is part of the current protocol.

protocol_name

pub const protocol_name: String

protocol_version

pub const protocol_version: Int

ref

pub fn ref(frame: Frame) -> String

Return the frame reference when one exists.