View Source Chorex.RuntimeState (Chorex v0.8.7)

Summary

Types

inbox_msg()

An entry in the inbox looks like a CIV token × message payload

stack_frame()

t()

var_map()

Functions

ditch_recover_frame(state)

Throw away the top frame, assuming it's a recover frame. If it's not, raise an error.

drop_inbox(msg, state)

pop_to_recover_frame(state)

Drop everything up to the first recover frame on the stack. Return the recovery token as well as the state with the stack popped.

push_barrier_frame(id, state)

push_continue_frame(cont_tok, state)

push_func_frame(cont_tok, state)

push_inbox(msg, state)

push_recover_frame(tok, state)

push_recv_frame(arg, state)

put_var(state, name, val)

Types

inbox_msg()

@type inbox_msg() :: {Chorex.Types.civ_tok(), msg :: any()}

An entry in the inbox looks like a CIV token × message payload

stack_frame()

@type stack_frame() ::
  {:recv, civ_tok :: Chorex.Types.civ_tok(),
   match_fun :: (any() -> false | var_map()), cont_tok :: String.t(),
   vars :: var_map()}
  | {:return, cont_tok :: String.t(), vars :: var_map()}

t()

@type t() :: %Chorex.RuntimeState{
  actor: term(),
  config: nil | %{required(atom()) => pid()},
  impl: atom(),
  inbox: :queue.queue(inbox_msg()),
  session_token: String.t(),
  stack: [stack_frame()],
  vars: var_map(),
  waiting_value: any()
}

var_map()

@type var_map() :: %{} | %{required(atom()) => any()}

Functions

ditch_recover_frame(state)

Throw away the top frame, assuming it's a recover frame. If it's not, raise an error.

drop_inbox(msg, state)

@spec drop_inbox(inbox_msg(), t()) :: t()

pop_to_recover_frame(state)

@spec pop_to_recover_frame(t()) :: {String.t(), t()}

Drop everything up to the first recover frame on the stack. Return the recovery token as well as the state with the stack popped.

push_barrier_frame(id, state)

push_continue_frame(cont_tok, state)

@spec push_continue_frame(String.t(), t()) :: t()

push_func_frame(cont_tok, state)

@spec push_func_frame(String.t(), t()) :: t()

push_inbox(msg, state)

@spec push_inbox(inbox_msg(), t()) :: t()

push_recover_frame(tok, state)

@spec push_recover_frame(String.t(), t()) :: t()

push_recv_frame(arg, state)

@spec push_recv_frame({Chorex.Types.civ_tok(), any(), String.t()}, t()) :: t()

put_var(state, name, val)

@spec put_var(t(), atom(), any()) :: t()