diff options
| author | s-ol <s-ol@users.noreply.github.com> | 2020-04-13 18:40:35 +0000 |
|---|---|---|
| committer | s-ol <s-ol@users.noreply.github.com> | 2020-04-14 08:46:54 +0000 |
| commit | 1a8debe87762072b3a63b769aa515ebf63b4c70d (patch) | |
| tree | 33b42866307d11d2c0878b23e0ec0bb8925d3fcc /core/stream/base.moon | |
| parent | spec base.match __tostring (diff) | |
| download | alive-1a8debe87762072b3a63b769aa515ebf63b4c70d.tar.gz alive-1a8debe87762072b3a63b769aa515ebf63b4c70d.zip | |
move into proper Lua module (`alv`)
Diffstat (limited to 'core/stream/base.moon')
| -rw-r--r-- | core/stream/base.moon | 68 |
1 files changed, 0 insertions, 68 deletions
diff --git a/core/stream/base.moon b/core/stream/base.moon deleted file mode 100644 index 37cc8a4..0000000 --- a/core/stream/base.moon +++ /dev/null @@ -1,68 +0,0 @@ ----- --- base Stream interface. --- --- implemented by `ValueStream`, `EventStream`, and `IOStream`. --- --- @classmod Stream - -class Stream ---- Stream interface. --- --- Methods that have to be implemented by `Stream` implementations --- (`ValueStream`, `EventStream`, `IOStream`). --- --- @section interface - - --- return whether this Stream was changed in the current tick. - -- - -- @function dirty - -- @treturn boolean - - --- create a mutable copy of this Stream. - -- - -- Used to insulate eval-cycles from each other. - -- - -- @function fork - -- @treturn Stream - - --- 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 - -- - -- @tfield string type - - --- 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) - -- - -- @tfield ?table meta - ---- static functions --- @section static - - --- construct a new Stream. - -- - -- @classmethod - -- @tparam string type the type name - -- @tparam ?table meta the `meta` table - new: (@type, @meta={}) => - -{ - :Stream -} |