retrace/wire

Versioned, application-neutral delivery envelopes. Payloads are application-encoded strings. This module checks transport and sequence invariants; it does not interpret the application’s model.

Types

Batch

</>

pub type Batch {
  Batch(
    session: Session,
    checkpoint: retrace.Checkpoint(String),
    entries: List(retrace.Entry(Event)),
  )
}

Constructors

Batch(
  session: Session,
  checkpoint: retrace.Checkpoint(String),
  entries: List(retrace.Entry(Event)),
)

Error

</>

pub type Error {
  MalformedEnvelope
  InvalidSession
  EmptyBatch
  TooManyEntries
  TooLarge
  InvalidHistory(retrace.Error(Nil))
}

Constructors

```
MalformedEnvelope
```
```
InvalidSession
```
```
EmptyBatch
```
```
TooManyEntries
```
```
TooLarge
```
```
InvalidHistory(retrace.Error(Nil))
```

Event

</>

pub type Event {
  Event(kind: String, payload: String)
}

Constructors

```
Event(kind: String, payload: String)
```

Session

</>

pub type Session {
  Session(
    id: String,
    user_ref: String,
    build: String,
    contract: String,
    platform: String,
  )
}

Constructors

Session(
  id: String,
  user_ref: String,
  build: String,
  contract: String,
  platform: String,
)

Values

decode_batch

</>

pub fn decode_batch(input: String) -> Result(Batch, Error)

encode

</>

pub fn encode(batch: Batch) -> String

end_sequence

</>

pub fn end_sequence(batch: Batch) -> Int

end_time

</>

pub fn end_time(batch: Batch) -> Int

max_bytes

</>

pub const max_bytes: Int

max_entries

</>

pub const max_entries: Int

origin

</>

pub fn origin(session: Session) -> retrace.Origin

session_decoder

</>

pub fn session_decoder() -> decode.Decoder(Session)

session_json

</>

pub fn session_json(session: Session) -> json.Json

valid_id

</>

pub fn valid_id(id: String) -> Bool

validate

</>

pub fn validate(batch: Batch) -> Result(Nil, Error)