ReactivePublisherSchema

The ReactivePublisherSchema class is used to define the data pipeline which handles observed values from ReactiveState or ReactiveStream objects. These data pipelines are compiled into Lua functions, so their execution is highly performant.

Stages

The data pipeline has two stages:

The first stage applies transformations and filters to published values. Transformations (e.g. :Map()) change the value passing to the next step. Filters (e.g. :Ignore*()) either allow the current value through or halt the pipeline. Any number of transformations and filters may be defined in any order.

The second stage handles the final value via :Call*() or :AssignToTableKey(). Exactly one of these must be called — it commits the schema and returns a ReactivePublisher object.

Share

The :Share() method designates that the value at that point in the pipeline should be saved and shared across multiple subsequent data pipelines. It returns a ReactivePublisherSchemaShared object, which allows continuing from the commit methods before being finalized via :EndShare().

self._state:Publisher([[subAddEnabled and (mouseOver or hasFocus)]])
   :Share()
   :CallMethod(self._subIcon, "SetShown")
   :CallMethod(self._subBtn, "SetShown")
   :CallMethod(self._addIcon, "SetShown")
   :CallMethod(self._addBtn, "SetShown")
   :EndShare()

Flat Map

The :FlatMapCall*() methods allow transforming published values into a new publisher, where the first argument is a function that receives published values and returns a new publisher.

Memory Management

Publisher schema objects are acquired exclusively via methods on ReactiveState and ReactiveStream and are recycled internally when committed.

API

Inherits: Class

Methods

AssignToTableKey

function ReactivePublisherSchemaBase:AssignToTableKey(tbl, key)
  -> self

Assigns published values to the specified key in the table.

Parameters:

Name	Type	Description
tbl	table	The table to assign the published values into
key	string	The key to assign the published values at

Returns:

Type	Description
self

CallFunction

function ReactivePublisherSchemaBase:CallFunction(func, arg)
  -> self

Calls a function with the published values.

Parameters:

Name	Type	Description
func	fun(value: T, arg: A)	The function to call with the published values
arg	A	An additional argument to pass to the function

Returns:

Type	Description
self

CallMethod

function ReactivePublisherSchemaBase:CallMethod(obj, method, arg)
  -> self

Calls a method with the published values.

Parameters:

Name	Type	Description
obj	Obj	The object to call the method on
method	K	The name of the method to call with the published values
arg	any	An additional argument to pass to the method

Returns:

Type	Description
self

CoalesceNil

function ReactivePublisherSchemaBase:CoalesceNil(value)
  -> self

Coalesces nil published values to a specific value.

Parameters:

Name	Type	Description
value	V	The value to map to

Returns:

Type	Description
self

FlatMapCallFunction

function ReactivePublisherSchemaBase:FlatMapCallFunction(map, func, arg)
  -> self

Maps published values to a new publisher which is owned by the current publisher and call a function with values it publishes.

Parameters:

Name	Type	Description
map	ReactivePublisherFlatMapFunc<T>	A function which takes a published value and returns a new publisher
func	fun(value: T, arg: A)	The function to call with the published values
arg	A	An additional argument to pass to the function

Returns:

Type	Description
self

FlatMapCallMethod

function ReactivePublisherSchemaBase:FlatMapCallMethod(map, obj, method, arg)
  -> self

Maps published values to a new publisher which is owned by the current publisher and call a method with values it publishes.

Parameters:

Name	Type	Description
map	ReactivePublisherFlatMapFunc<T>	A function which takes a published value and returns a new publisher
obj	Obj	The object to call the method on
method	K	The name of the method to call with the published values
arg	any	An additional argument to pass to the method

Returns:

Type	Description
self

IgnoreDuplicates

function ReactivePublisherSchemaBase:IgnoreDuplicates(hashFunc)
  -> self

Ignores duplicate published values.

Parameters:

Name	Type	Description
hashFunc	string	A method call (in the form "MyMethod()") to calculate the hash to check for equality

Returns:

Type	Description
self

IgnoreDuplicatesWithKeys

function ReactivePublisherSchemaBase:IgnoreDuplicatesWithKeys(...)
  -> self

Ignores duplicate published values by checking the specified keys.

Parameters:

Name	Type	Description
...	K	Keys to compare to detect duplicate published values

Returns:

Type	Description
self

IgnoreIfEquals

function ReactivePublisherSchemaBase:IgnoreIfEquals(value, key)
  -> self

Ignores published values which equal the specified value.

Parameters:

Name	Type	Description
value	V	The value to compare against
key	K	The key to access for filtering

Returns:

Type	Description
self

IgnoreIfNotEquals

function ReactivePublisherSchemaBase:IgnoreIfNotEquals(value, key)
  -> self

Ignores published values which don't equal the specified value.

Parameters:

Name	Type	Description
value	V	The value to compare against
key	K	The key to access for filtering

Returns:

Type	Description
self

IgnoreNil

function ReactivePublisherSchemaBase:IgnoreNil()
  -> self

Ignores published values if it's nil.

Returns:

Type	Description
self

InvertBoolean

function ReactivePublisherSchemaBase:InvertBoolean()
  -> self

Invert published boolean values.

Returns:

Type	Description
self

IsShared

function ReactivePublisherSchemaBase:IsShared()
  -> boolean

Returns whether or not this is a shared publisher.

Returns:

Type	Description
boolean

Map

function ReactivePublisherSchemaBase:Map(map, arg)
  -> self

Map published values to another value.

Parameters:

Name	Type	Description
map	fun(value: T, arg: A): any | string | number | table<T, R>	Either a map function, table key (string or number) to index, method call (in the form "MyMethod()"), or lookup table
arg	A	An additional argument to pass to a map function

Returns:

Type	Description
self

MapNonNil

function ReactivePublisherSchemaBase:MapNonNil(map, arg)
  -> self

Map non-nil publishes values to another value.

Parameters:

Name	Type	Description
map	fun(value: T, arg: A): R | string | table<T, R>	Either a map function, method call (in the form "MyMethod()"), or lookup table
arg	A	An additional argument to pass to the map function or method

Returns:

Type	Description
self

Print

function ReactivePublisherSchemaBase:Print(tag)
  -> self

Prints published values and passes them through for debugging purposes.

Parameters:

Name	Type	Description
tag	string	An optional tag to add to the prints

Returns:

Type	Description
self

ReplaceBooleanWith

function ReactivePublisherSchemaBase:ReplaceBooleanWith(trueValue, falseValue)
  -> self

Replaces published boolean values with the specified true / false values.

Parameters:

Name	Type	Description
trueValue	V1	The value to replace with to if true
falseValue	V2	The value to replace with to if false

Returns:

Type	Description
self

ReplaceWith

function ReactivePublisherSchemaBase:ReplaceWith(value)
  -> self

Replaces published values with the specific value.

Parameters:

Name	Type	Description
value	V	The value to replace with

Returns:

Type	Description
self

ToBooleanEquals

function ReactivePublisherSchemaBase:ToBooleanEquals(value)
  -> self

Map published values to a boolean based on whether or not it equals the specified value.

Parameters:

Name	Type	Description
value	T	The value to compare with

Returns:

Type	Description
self

ToBooleanGreaterThanOrEquals

function ReactivePublisherSchemaBase:ToBooleanGreaterThanOrEquals(value)
  -> self

Map published values to a boolean based on whether or not it is greater than or equal to the specified value.

Parameters:

Name	Type	Description
value	T	The value to compare with

Returns:

Type	Description
self

ToBooleanLessThanOrEquals

function ReactivePublisherSchemaBase:ToBooleanLessThanOrEquals(value)
  -> self

Map published values to a boolean based on whether or not it is less than or equal to the specified value.

Parameters:

Name	Type	Description
value	T	The value to compare with

Returns:

Type	Description
self

ToBooleanNotEquals

function ReactivePublisherSchemaBase:ToBooleanNotEquals(value)
  -> self

Map published values to a boolean based on whether or not it equals the specified value.

Parameters:

Name	Type	Description
value	T	The value to compare with

Returns:

Type	Description
self

ToStringFormat

function ReactivePublisherSchemaBase:ToStringFormat(formatStr)
  -> self

Map published values as arguments to a format string.

Parameters:

Name	Type	Description
formatStr	string	The string to format with the published values

Returns:

Type	Description
self

_AddStepHelper

function ReactivePublisherSchemaBase:_AddStepHelper(stepType, ...)
  -> self

Parameters:

Name	Type	Description
stepType	EnumValue
...	any

Returns:

Type	Description
self

__init

function ReactivePublisherSchemaBase:__init(isShared)

Parameters:

Name	Type	Description
isShared	``

Inherits: ReactivePublisherSchemaBase, Class

Methods

AssignToTableKey

function ReactivePublisherSchema:AssignToTableKey(tbl, key)
  -> ReactivePublisher

Assigns published values to the specified key in the table.

Parameters:

Name	Type	Description
tbl	TBL	The table to assign the published values into
key	K	The key to assign the published values at

Returns:

Type	Description
ReactivePublisher

CallFunction

function ReactivePublisherSchema:CallFunction(func, arg)
  -> ReactivePublisher

Calls a function with the published values.

Parameters:

Name	Type	Description
func	fun(value: T)	The function to call with the published values
arg	any	An additional argument to pass to the function

Returns:

Type	Description
ReactivePublisher

CallMethod

function ReactivePublisherSchema:CallMethod(obj, method, arg)
  -> ReactivePublisher

Calls a method with the published values.

Parameters:

Name	Type	Description
obj	Obj	The object to call the method on
method	K	The name of the method to call with the published values
arg	any	An additional argument to pass to the method

Returns:

Type	Description
ReactivePublisher

FlatMapCallFunction

function ReactivePublisherSchema:FlatMapCallFunction(map, func, arg)
  -> ReactivePublisher

Maps published values to a new publisher which is owned by the current publisher and call a function with values it publishes.

Parameters:

Name	Type	Description
map	ReactivePublisherFlatMapFunc<T>	A function which takes a published value and returns a new publisher
func	fun(value: any)	The function to call with the published values
arg	any	An additional argument to pass to the function

Returns:

Type	Description
ReactivePublisher

FlatMapCallMethod

function ReactivePublisherSchema:FlatMapCallMethod(map, obj, method, arg)
  -> ReactivePublisher

Maps published values to a new publisher which is owned by the current publisher and call a method with values it publishes.

Parameters:

Name	Type	Description
map	ReactivePublisherFlatMapFunc<T>	A function which takes a published value and returns a new publisher
obj	table	The object to call the method on
method	string	The name of the method to call with the published values
arg	any	An additional argument to pass to the method

Returns:

Type	Description
ReactivePublisher

Share

function ReactivePublisherSchema:Share()
  -> ReactivePublisherSchemaShared

Shares the result of the publisher at the current point in the chain.

Returns:

Type	Description
ReactivePublisherSchemaShared

_Acquire

function ReactivePublisherSchema:_Acquire(subject)

Parameters:

Name	Type	Description
subject	ReactiveSubject<T>

_AddStepHelper

function ReactivePublisherSchema:_AddStepHelper(stepType, ...)

Parameters:

Name	Type	Description
stepType	``
...	``

_Commit

function ReactivePublisherSchema:_Commit()

_Release

function ReactivePublisherSchema:_Release()

__init

function ReactivePublisherSchema:__init()

Functions

Get

function ReactivePublisherSchema.Get(subject)
  -> ReactivePublisherSchema

Gets a publisher schema object.

Parameters:

Name	Type	Description
subject	ReactiveSubject<T>	The subject which is publishing values

Returns:

Type	Description
ReactivePublisherSchema

Inherits: ReactivePublisherSchemaBase, Class

Methods

AssignToTableKey

function ReactivePublisherSchemaShared:AssignToTableKey(tbl, key)
  -> self

Assigns published values to the specified key in the table.

Parameters:

Name	Type	Description
tbl	table	The table to assign the published values into
key	string	The key to assign the published values at

Returns:

Type	Description
self

CallFunction

function ReactivePublisherSchemaShared:CallFunction(func, arg)
  -> self

Calls a function with the published values.

Parameters:

Name	Type	Description
func	fun(value: TCur, arg: A)	The function to call with the published values
arg	A	An additional argument to pass to the function

Returns:

Type	Description
self

CallMethod

function ReactivePublisherSchemaShared:CallMethod(obj, method, arg)
  -> self

Calls a method with the published values.

Parameters:

Name	Type	Description
obj	Obj	The object to call the method on
method	K	The name of the method to call with the published values
arg	any	An additional argument to pass to the method

Returns:

Type	Description
self

EndShare

function ReactivePublisherSchemaShared:EndShare()
  -> ReactivePublisher

Ends the share.

Returns:

Type	Description
ReactivePublisher

FlatMapCallFunction

function ReactivePublisherSchemaShared:FlatMapCallFunction(map, func, arg)
  -> self

Maps published values to a new publisher which is owned by the current publisher and call a function with values it publishes.

Parameters:

Name	Type	Description
map	ReactivePublisherFlatMapFunc<TCur>	A function which takes a published value and returns a new publisher
func	fun(value: TCur, arg: A)	The function to call with the published values
arg	A	An additional argument to pass to the function

Returns:

Type	Description
self

FlatMapCallMethod

function ReactivePublisherSchemaShared:FlatMapCallMethod(map, obj, method, arg)
  -> self

Maps published values to a new publisher which is owned by the current publisher and call a method with values it publishes.

Parameters:

Name	Type	Description
map	ReactivePublisherFlatMapFunc<TCur>	A function which takes a published value and returns a new publisher
obj	Obj	The object to call the method on
method	K	The name of the method to call with the published values
arg	any	An additional argument to pass to the method

Returns:

Type	Description
self

_Acquire

function ReactivePublisherSchemaShared:_Acquire(parentSchema, codeGen)

Parameters:

Name	Type	Description
parentSchema	ReactivePublisherSchemaBase
codeGen	ReactivePublisherCodeGen

_AddStepHelper

function ReactivePublisherSchemaShared:_AddStepHelper(stepType, ...)

Parameters:

Name	Type	Description
stepType	``
...	``

_Commit

function ReactivePublisherSchemaShared:_Commit()

_Release

function ReactivePublisherSchemaShared:_Release()

__init

function ReactivePublisherSchemaShared:__init()

Functions

Get

function ReactivePublisherSchemaShared.Get(parentSchema, codeGen)
  -> ReactivePublisherSchemaShared

Gets a shared publisher schema object.

Parameters:

Name	Type	Description
parentSchema	ReactivePublisherSchemaBase	The parent schema which is being shared
codeGen	ReactivePublisherCodeGen	The code gen object to add steps to

Returns:

Type	Description
ReactivePublisherSchemaShared