sprocket/runtime

Types

Message

pub opaque type Message

RenderedUpdate

</>

pub type RenderedUpdate {
  FullUpdate(ReconciledElement)
  PatchUpdate(patch: Patch)
}

Constructors

```
FullUpdate(ReconciledElement)
```
```
PatchUpdate(patch: Patch)
```

Runtime

</>

pub type Runtime =
  Subject(Message)

State

</>

pub opaque type State

Functions

get_reconciled

</>

pub fn get_reconciled(
  actor: Subject(Message),
) -> Option(ReconciledElement)

Get the previously reconciled state from the actor. This is useful for testing.

process_client_hook

</>

pub fn process_client_hook(
  actor: Subject(Message),
  id: String,
  event: String,
  payload: Option(Dynamic),
  reply_dispatcher: fn(String, Option(String)) ->
    Result(Nil, Nil),
) -> Nil

Get the client hook for a given id

process_event

</>

pub fn process_event(
  actor: Subject(Message),
  id: String,
  payload: Option(String),
) -> Nil

Get the event handler for a given id

process_event_immediate

</>

pub fn process_event_immediate(
  actor: Subject(Message),
  id: String,
  payload: Option(String),
) -> Result(Nil, Nil)

reconcile_immediate

</>

pub fn reconcile_immediate(
  actor: Subject(Message),
) -> ReconciledElement

Reconcile the view - should only be used for testing purposes

render_update

</>

pub fn render_update(actor: Subject(Message)) -> Nil

start

</>

pub fn start(
  view: Element,
  updater: Updater(RenderedUpdate),
  dispatcher: Option(Dispatcher),
) -> Result(Subject(Message), StartError)

Start a new runtime actor

stop

</>

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

Stop a runtime actor