class Input

Update scheduling policy for Op arguments.

index

members

• input:__call()  – alias for unwrap.

static functions

• Input.cold(value)  – Create a cold Input.
• Input.hot(value)  – Create a hot Input.

input interface

• Input(stream)  – create a new Input.
• input:setup(prev)  – copy state from old instance (optional).
• input:dirty()  – whether this input requires processing (optional).
• input:finish_setup()  – leave setup state (optional).
• input:unwrap()  – unwrap to Lua value (optional).
• input:type()  – return the type name of this Input (optional).
• input:metatype()  – return the metatype name of this Input (optional).
• input.stream  – the current value

details

members

• input:__call()  – alias for unwrap.

static functions

• Input.cold(value)  – Create a cold Input.
  Never marked dirty. Use this for input streams that are only read when another Input is dirty.

  parameters:

  • value (Stream or Result)
• Input.hot(value)  – Create a hot Input.
  Behaviour depends on what kind of Stream value is:

  • ValueStream: Marked dirty only if old and new ValueStream differ.
  • EventStream and IOStream: Marked dirty only if the current EventStream is dirty.

  This is the most common Input strategy.

  parameters:

  • value (Stream or Result)

input interface

• Input(stream)  – create a new Input.

  parameters:

  • stream (Stream)
• input:setup(prev)  – copy state from old instance (optional).
  called by Op:setup with another Input instance or nil once this instance is registered. Must prepare this instance for dirty.

  May enter a ‘setup state’ that is exited using finish_setup.

  parameters:

  • prev (optional Input): previous Input intance or nil
• input:dirty()  – whether this input requires processing (optional).
  must return a boolean indicating whether Ops that refer to this instance should be notified (via Op:tick). If not overwritten, delegates to stream:dirty.

  returns:

  1. (bool): whether processing is necessary
• input:finish_setup()  – leave setup state (optional).
  called after the Op has completed (or skipped) its first Op:tick after Op:setup. Must prepare this instance for dataflow operation.
• input:unwrap()  – unwrap to Lua value (optional).

  returns:

  1. (any): the raw Lua value
• input:type()  – return the type name of this Input (optional).
• input:metatype()  – return the metatype name of this Input (optional).
• input.stream  – the current value
  • stream (ValueStream)