mooncakes.io

clipboard
→
cmd
→
common
→
dialog
→
dom
→
html
→
http
→
js
→
nav
→
sub
→
svg
→
url
→
variant
→
websocket
→
README
U
Cell
U
Cmd
U
Emit
U
Enumerate
U
Html
U
Resource
T
App
- ::renderApp::render
T
Status
T
Val
- ::assocVal::assoc
- ::assoc_byVal::assoc_by
- ::constantVal::constant
- ::enumerateVal::enumerate
- ::enumerate_byVal::enumerate_by
- ::mapVal::map
- ::map2Val::map2
- ::map3Val::map3
- ::map4Val::map4
- ::map5Val::map5
- ::map6Val::map6
- ::map7Val::map7
- ::map8Val::map8
- ::map9Val::map9
- ::switchVal::switch
- ::switch_byVal::switch_by
- ::viewVal::view
- ::view2Val::view2
- ::view3Val::view3
- ::view4Val::view4
- ::view5Val::view5
- ::view6Val::view6
- ::view7Val::view7
- ::view8Val::view8
- ::view9Val::view9
V
batch
V
cell
V
cell_with_emit
V
create_pure_state
V
create_resource
V
create_state
V
create_state_with_init
V
create_state_with_input
V
create_variable
V
delay
V
elmish
V
new
V
none
V
simple_cell
V
simple_cell_with_emit
V
static_cell

README

moonbit-community/rabbita/cmd does not have a README file

#
Settle

type Settle = (Json) -> Unit

#
Context

source

#internal(experimental, "This API is unstable and may change in the future.")
pub(open) trait Context {
  #internal(experimental, "This API is unstable and may change in the future.")
  fn get_origin(Self) -> String
  #internal(experimental, "This API is unstable and may change in the future.")
  fn inject_url_changed(Self, String) -> Cmd
  #internal(experimental, "This API is unstable and may change in the future.")
  fn inject_url_request(Self, String) -> Cmd
}

#
Scheduler

source

pub(open) trait Scheduler : Context {
  fn add(Self, Cmd) -> Unit = _
  #internal(experimental, "This API is unstable and may change in the future.")
  fn queue_command(Self, Cmd) -> Unit
  #internal(experimental, "This API is unstable and may change in the future.")
  fn set_url_changed_injector(Self, Injector[String]) -> Unit
  #internal(experimental, "This API is unstable and may change in the future.")
  fn set_url_request_injector(Self, Injector[String]) -> Unit
}

#
HydrateExn

source

#internal(experimental, "This API is unstable and may change in the future.")
pub(all) suberror HydrateExn {
  Unhandled
  Fallback
  Skip
}

#
Unhandled

source

#internal(experimental, "This API is unstable and may change in the future.")
pub(all) suberror Unhandled

#
Cmd

source

type Cmd

A deferred command handled by the Rabbita runtime.

Cmd models side effects in the update loop. Commands are returned from update or embedded in Html event handlers, and are executed later by the runtime.

impl Debug for Cmd

#
EffectKind

source

pub(all) enum EffectKind {
  Immediately
  AfterRender
}

#
Emit

source

#alias(Dispatch, deprecated="Use Emit[Msg] instead.")
pub(all) struct Emit[Msg]((Msg) -> Cmd)

#
Emit::map

source

fn[A, B] Emit::map(self : Emit[A], f : (B) -> A) -> Emit[B]

#
Extension

source

#internal(experimental, "This API is unstable and may change in the future.")
pub(all) extenum Extension {
}

#
Injector

source

#internal(experimental, "This API is unstable and may change in the future.")
pub(all) struct Injector[Arg]((Arg) -> Cmd)

#
Op

source

#internal(experimental, "This API is unstable and may change in the future.")
type Op

#
Op::Op

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Op::Op() -> Op

#
Op::on_debug

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Op::on_debug(self : Op, f : (Extension) -> @moonbitlang/core/debug.Repr
Repr raise Unhandled) -> Unit

#
Op::on_identify

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Op::on_identify(self : Op, identify : (Extension) -> String raise Unhandled) -> Unit

Registers the identity used to store and resume this command's SSR transcript value. Authors must return different keys for commands that may need different transcript values during hydration.

#
Op::on_invoke

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Op::on_invoke(self : Op, f : (Extension, &Context) -> OpCont[Cmd] raise Unhandled) -> Unit

#
Op::on_resume

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Op::on_resume(self : Op, f : (Extension, Json, &Context) -> Cmd raise HydrateExn) -> Unit

#
Op::on_settle

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Op::on_settle(self : Op, f : (Extension, &Context) -> OpCont[(Json, Cmd)] raise Unhandled) -> Unit

#
Op::request

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Op::request(self : Op, extension : Extension) -> Cmd

#
OpCont

source

#internal(experimental, "This API is unstable and may change in the future.")
pub(all) enum OpCont[T] {
  None
  Ready(T)
  Async(async () -> T)
  AfterLayout(() -> T)
  LegacyEffect(EffectKind, (&Scheduler) -> Unit)
}

#
Runner

source

#internal(experimental, "This API is unstable and may change in the future.")
type Runner

#
Runner::identify

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Runner::identify(runner : Runner, extension : Extension) -> String raise Unhandled

#
Runner::invoke

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Runner::invoke(runner : Runner, extension : Extension, context : &Context) -> OpCont[Cmd] raise Unhandled

#
Runner::resume_

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Runner::resume_(runner : Runner, extension : Extension, value : Json, context : &Context) -> Cmd raise HydrateExn

#
Runner::settle

source

#internal(experimental, "This API is unstable and may change in the future.")
fn Runner::settle(runner : Runner, extension : Extension, context : &Context) -> OpCont[(Json, Cmd)] raise Unhandled

#
after_render

source

let after_render : EffectKind

#
batch

source

fn batch(cmds : Array[Cmd]) -> Cmd

Combine multiple commands into one command.

#
custom_cmd

source

#alias(raw_effect, deprecated="`raw_effect` is deprecated, use `custom_cmd` instead")
fn custom_cmd(callback : (&Scheduler) -> Unit, kind? : EffectKind) -> Cmd

Create a low-level effect command for runtime and FFI integration. Consider use higher-level helpers like perform, delay, @http.post(), and @dialog.show() in app code.

This function allows you to write wrappers that encapsulate FFI in a command when the functionality is not provided by Rabbita yet.

Parameters:

callback: receives the runtime Scheduler, so it can enqueue follow-up commands (for example, after an async callback).
kind: determines when the effect runs.
- Immediately: run as soon as the runtime receives it.
- AfterRender: run after DOM patching for the current flush completes.

Example:

extern "js" fn set_timeout(f : () -> Unit, ms : Int) = "(f,ms) => setTimeout(f, ms)"

pub fn delay(cmd : Cmd, ms : Int) -> Cmd {
  raw_effect(scheduler => set_timeout(() => scheduler.add(cmd), ms))
}

#
delay

source

fn delay(cmd : Cmd, ms : Int) -> Cmd

#
immediately

source

let immediately : EffectKind

#
none

source

let none : Cmd

A command that does nothing.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Settle

#Context

#Scheduler

#HydrateExn

#Unhandled

#Cmd

#EffectKind

#Emit

#Emit::map

#Extension

#Injector

#Op

#Op::Op

#Op::on_debug

#Op::on_identify

#Op::on_invoke

#Op::on_resume

#Op::on_settle

#Op::request

#OpCont

#Runner

#Runner::identify

#Runner::invoke

#Runner::resume_

#Runner::settle

#after_render

#batch

#custom_cmd

#delay

#immediately

#none

Source Files

#
Settle

#
Context

#
Scheduler

#
HydrateExn

#
Unhandled

#
Cmd

#
EffectKind

#
Emit

#
Emit::map

#
Extension

#
Injector

#
Op

#
Op::Op

#
Op::on_debug

#
Op::on_identify

#
Op::on_invoke

#
Op::on_resume

#
Op::on_settle

#
Op::request

#
OpCont

#
Runner

#
Runner::identify

#
Runner::invoke

#
Runner::resume_

#
Runner::settle

#
after_render

#
batch

#
custom_cmd

#
delay

#
immediately

#
none