class ValueStream

Continuous stream of values.

Implements the Stream and AST intefaces.

index

members

• valuestream:dirty()  – return whether this stream was changed in the current tick.
• valuestream:set(value)  – update this stream’s value.
• valuestream:unwrap([type[, msg]])  – unwrap to the Lua type.
• valuestream:fork()  – create a mutable copy of this stream.
• valuestream:__call(...)  – alias for unwrap.
• valuestream:__eq(other)  – compare two values.
• valuestream.metatype()  – Stream metatype.
• valuestream.value  – the wrapped Lua value.
• valuestream.meta  – documentation metadata.

static functions

• ValueStream(type, value, raw)  – construct a new ValueStream.
• ValueStream:parse(type, sep)  – create a capture-function (for parsing with Lpeg).
• ValueStream.wrap(val[, name])  – wrap a Lua value.
• ValueStream.num(num)  – create a constant number.
• ValueStream.str(str)  – create a constant string.
• ValueStream.sym(sym)  – create a constant symbol.
• ValueStream.bool(bool)  – create a constant boolean.
• ValueStream.meta(args)  – wrap and document a value.

ast interface

• valuestream:eval(scope)  – evaluate this literal constant.
• valuestream:stringify()  – stringify this literal constant.
• valuestream:clone(prefix)  – clone this literal constant.

details

members

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

  returns:

  1. (bool)
• valuestream:set(value)  – update this stream’s value.
  Marks this stream as dirty for the remainder of the current tick.

  parameters:

  • value
• valuestream:unwrap([type[, msg]])  – unwrap to the Lua type.
  Asserts @type == type if type is given.

  parameters:

  • type (string): the type to check for (optional)
  • msg (string): message to throw if type don’t match (optional)

  returns:

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

  returns:

  1. (ValueStream)
• valuestream:__call(...)  – alias for unwrap.

  parameters:

  • ...
• valuestream:__eq(other)  – compare two values.
  Compares two ValueStreams by comparing their types and their Lua values.

  parameters:

  • other
• valuestream.metatype()  – Stream metatype.
• valuestream.value  – the wrapped Lua value.
  • value (any)
• valuestream.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)

static functions

• ValueStream(type, value, raw)  – construct a new ValueStream.

  parameters:

  • type (string): the type name
  • value (any): the Lua value to be accessed through unwrap
  • raw (string): the raw string that resulted in this value. Used by parsing.
• ValueStream:parse(type, sep)  – create a capture-function (for parsing with Lpeg).

  parameters:

  • type (string): the type name (one of num, sym or str)
  • sep (string): the seperator char (only for str)
• ValueStream.wrap(val[, name])  – wrap a Lua value.
  Attempts to guess the type and wrap a Lua value.

  parameters:

  • val (any): the value to wrap
  • name (string): the name of this value (for error logging) (optional)

  returns:

  1. (ValueStream)
• ValueStream.num(num)  – create a constant number.

  parameters:

  • num (number): the number

  returns:

  1. (ValueStream)
• ValueStream.str(str)  – create a constant string.

  parameters:

  • str (string): the string

  returns:

  1. (ValueStream)
• ValueStream.sym(sym)  – create a constant symbol.

  parameters:

  • sym (string): the symbol

  returns:

  1. (ValueStream)
• ValueStream.bool(bool)  – create a constant boolean.

  parameters:

  • bool (boolean): the boolean

  returns:

  1. (ValueStream)
• ValueStream.meta(args)  – wrap and document a value.
  wraps args.value using wrap, then assigns meta.

  parameters:

  • args (table): table with keys value and meta

  returns:

  1. (ValueStream)

ast interface

• valuestream:eval(scope)  – evaluate this literal constant.
  Throws an error if type is not a literal (num, str or sym). Returns an eval-time const result for num and str. Resolves syms in scope and returns a reference to them.

  parameters:

  • scope (Scope): the scope to evaluate in

  returns:

  1. (Result): the evaluation result
• valuestream:stringify()  – stringify this literal constant.
  Throws an error if raw is not set.

  returns:

  1. (string): the exact string this stream was parsed from
• valuestream:clone(prefix)  – clone this literal constant.

  parameters:

  • prefix

  returns:

  1. (ValueStream): self