sprocket/cassette

Types

CSRFValidator

pub type CSRFValidator =
  fn(String) -> Result(Nil, Nil)

Cassette

</>

pub type Cassette =
  Subject(Message)

CassetteOpts

</>

pub type CassetteOpts {
  CassetteOpts(debug: Bool)
}

Constructors

```
CassetteOpts(debug: Bool)
```

Message

</>

pub type Message {
  Shutdown
  GetState(reply_with: Subject(State))
  PushSprocket(sprocket: Sprocket)
  GetSprocket(
    reply_with: Subject(Result(Sprocket, Nil)),
    id: Unique,
  )
  PopSprocket(
    reply_with: Subject(Result(Sprocket, Nil)),
    id: Unique,
  )
}

Constructors

```
Shutdown
```
```
GetState(reply_with: Subject(State))
```
```
PushSprocket(sprocket: Sprocket)
```

GetSprocket(
  reply_with: Subject(Result(Sprocket, Nil)),
  id: Unique,
)

PopSprocket(
  reply_with: Subject(Result(Sprocket, Nil)),
  id: Unique,
)

State

</>

pub type State {
  State(
    sprockets: List(Sprocket),
    debug: Bool,
    csrf_validator: CSRFValidator,
    cuid_channel: Subject(cuid.Message),
  )
}

Constructors

State(
  sprockets: List(Sprocket),
  debug: Bool,
  csrf_validator: CSRFValidator,
  cuid_channel: Subject(cuid.Message),
)

Functions

client_message

</>

pub fn client_message(
  ca: Subject(Message),
  id: Unique,
  view: Element,
  msg: String,
  ws_send: fn(String) -> Result(Nil, Nil),
) -> Result(Nil, Nil)

get_sprocket

</>

pub fn get_sprocket(
  ca: Subject(Message),
  ws: Unique,
) -> Result(Subject(sprocket/sprocket.Message), Nil)

Gets a sprocket from the cassette.

get_state

</>

pub fn get_state(ca: Subject(Message)) -> State

Get the current state of the cassette. Mostly intended for unit tests and debugging.

pop_sprocket

</>

pub fn pop_sprocket(
  ca: Subject(Message),
  ws: Unique,
) -> Result(Subject(sprocket/sprocket.Message), Nil)

Pops a sprocket from the cassette.

push_sprocket

</>

pub fn push_sprocket(
  ca: Subject(Message),
  sprocket: Subject(sprocket/sprocket.Message),
) -> Nil

Pushes a sprocket to the cassette.

start

</>

pub fn start(
  csrf_validator: fn(String) -> Result(Nil, Nil),
  opts: Option(CassetteOpts),
) -> Subject(Message)

Start the cassette. This is intended to only be called once during web server initiliazation.

The cassette is a long running process that manages the state of all sprockets and preflights.

stop

</>

pub fn stop(ca: Subject(Message)) -> Nil

Stop the cassette