yafrl-core/io.github.yafrl/BindingSignal

BindingSignal

class BindingSignal<A> : Signal<A> (source)

Variant of Signal that can be setTo a new value.

Constructed with the externalSignal function.

Properties

label

val label: String

node

val node: Node<A>

value

var value: A

Functions

asBehavior

inline fun <A> Signal<A>.asBehavior(): Behavior<A>

Utility to convert a Signal into a behavior whose values are interpreted as the piecewise function of the values of the Signal.

collectAsync

suspend fun collectAsync(collector: FlowCollector<A>)

Launches a handler that asynchronously listens to updates on the state.

collectSync

fun collectSync(collector: (A) -> Unit)

combineWith

fun <B, C> combineWith(state2: Signal, op: (A, B) -> C): Signal<C>

Combine two states together into a single Signal by applying a function to the two input states.

fun <B, C, D> combineWith(state2: Signal, state3: Signal<C>, op: (A, B, C) -> D): Signal<D>

fun <B, C, D, E> combineWith(state2: Signal, state3: Signal<C>, state4: Signal<D>, op: (A, B, C, D) -> E): Signal<E>

fun <B, C, D, E, F> combineWith(state2: Signal, state3: Signal<C>, state4: Signal<D>, state5: Signal<E>, op: (A, B, C, D, E) -> F): Signal<F>

flatMap

fun flatMap(f: SampleScope.(A) -> Signal): Signal

flatten

fun <A> Signal<Signal<A>>.flatten(): Signal<A>

Construct a State<A> from a nested State<State<A>> by updating whenever either the inner or outer Signal updates.

labeled

fun labeled(label: String): Signal<A>

map

fun map(f: SampleScope.(A) -> B): Signal

Applies the passed function f to each state, producing a new transformed Signal value.

plus

@JvmName(name = "plusFloat2")

operator fun Signal<Float2>.plus(other: Signal<Float2>): Signal<Float2>

@JvmName(name = "plusFloat23")

operator fun Signal<Float3>.plus(other: Signal<Float3>): Signal<Float3>

operator fun Signal<Float>.plus(other: Signal<Float>): Signal<Float>

switch

fun <A> Signal<Event<A>>.switch(): Event<A>

Constructs a flattened Event from a changing Signal of events over time.

switcher

fun <A> Signal<Behavior<A>>.switcher(): Behavior<A>

Constructs a behavior whose value is equal to the state's current behavior's value at all times.

switchMap

fun switchMap(f: SampleScope.(A) -> Event): Event

toString

open override fun toString(): String

updated

fun updated(): Event<A>

Get the Event with just the updates associated with a Signal.