class EventStream

Stream of momentary events.

index

members

• eventstream:dirty()  – return whether this stream was changed in the current tick.
• eventstream:add(event)  – push an event value into the stream.
• eventstream:unwrap([type[, msg]])  – get the sequence of current events (if any).
• eventstream:fork()  – create a mutable copy of this stream.
• eventstream:__call(...)  – alias for unwrap.
• eventstream.metatype()  – Stream metatype.
• eventstream.meta  – documentation metadata.

static functions

• EventStream(type)  – construct a new EventStream.

details

members

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

  returns:

  1. (bool)
• eventstream:add(event)  – push an event value into the stream.
  Marks this stream as dirty for the remainder of the current tick.

  parameters:

  • event (any)
• eventstream:unwrap([type[, msg]])  – get the sequence of current events (if any).
  Returns events if dirty, or an empty table otherwise. 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,...}): events
• eventstream:fork()  – create a mutable copy of this stream.
  Used to wrap insulate eval-cycles from each other.

  returns:

  1. (EventStream)
• eventstream:__call(...)  – alias for unwrap.

  parameters:

  • ...
• eventstream.metatype()  – Stream metatype.
• eventstream.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

• EventStream(type)  – construct a new EventStream.

  parameters:

  • type (string): the type name