class Stream

base Stream interface.

implemented by ValueStream, EventStream, and IOStream.

index

static functions

• Stream(type, meta)  – construct a new Stream.

stream interface

• stream:dirty()  – return whether this Stream was changed in the current tick.
• stream:fork()  – create a mutable copy of this Stream.
• stream.type  – the type name of this Stream’s value.
• stream.meta  – documentation metadata.

details

static functions

• Stream(type, meta)  – construct a new Stream.

  parameters:

  • type (string): the type name
  • meta (optional table): the meta table

stream interface

• stream:dirty()  – return whether this Stream was changed in the current tick.

  returns:

  1. (boolean)
• stream:fork()  – create a mutable copy of this Stream.
  Used to insulate eval-cycles from each other.

  returns:

  1. (Stream)
• stream.type  – the type name of this Stream’s value.

  the following builtin typenames are used:

  • str - strings, value is a Lua string
  • sym - symbols, value is a Lua string
  • num - numbers, value is a Lua number
  • bool - booleans, value is a Lua boolean
  • bang - trigger signals, value is a Lua boolean
  • opdef - value is an Op subclass
  • builtin - value is a Builtin subclass
  • fndef - value is a FnDef instance
  • scope - value is a Scope instance

  • type (string)
• stream.meta  – documentation metadata.

  an optional table containing metadata for error messages and documentation. The following keys are recognized:

  • name: optional name
  • summary: single-line description (markdown)
  • examples: optional list of single-line code examples
  • description: optional full-text description (markdown)

  • meta (optional table)