class Result

base Result interface.

implemented by Constant, SigStream, and EvtStream.

index

static functions

• Result\new(type, meta)  – construct a new Result.

result interface

• result\dirty()  – return whether this Result was changed in the current tick.
• result\fork()  – create a mutable copy of this Result.
• result.type  – the type of this Result's value.
• result.metatype  – the metatype string for this Result.
• result.meta  – documentation metadata.

details

static functions

• Result\new(type, meta)  – construct a new Result.

  parameters:

  • type (type.Type): the type
  • meta (optional table): the meta table

result interface

• result\dirty()  – return whether this Result was changed in the current tick.

  returns:

  1. (boolean)
• result\fork()  – create a mutable copy of this Result.
  Used to insulate eval-cycles from each other.

  returns:

  1. (Result)
• result.type  – the type of this Result's value.
  • type (type.Type)
• result.metatype  – the metatype string for this Result.
  one of = (Constant), ~ (SigStream), ! (EvtStream).

  • metatype (string)
• result.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)