watchable/io.gladed.watchable/WatchableValue

WatchableValue

A Watchable value of T which may also be replaced or bound. Use watchableValueOf to create.

interface WatchableValue<T> : MutableWatchable<MutableValue<T>, ValueChange<T>> , ReadOnlyWatchableValue<T>

Functions

batch

abstract override fun batch(scope: CoroutineScope, period: Long, func: SuspendFunction1<List<ValueChange<T>>, Unit>): Watcher

bind

Binds this unbound object to origin, such that when origin changes, this object is updated to match origin exactly, until scope completes. While bound, this object may not be externally modified or rebound.

abstract override fun bind(scope: CoroutineScope, origin: Watchable<ValueChange<T>>): Watcher

Binds this unbound object to origin, such that for every change to origin, the change is applied to this object with apply, until scope completes. While bound, this object may not be externally modified or rebound.

abstract override fun <C2 : Change> bind(scope: CoroutineScope, origin: Watchable<C2>, period: Long, apply: MutableValue<T>.(C2) -> Unit): Watcher

clear

Remove all items.

abstract suspend override fun clear()

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

invoke

Suspend until func can safely execute on the mutable form M of this watchable, returning func's result. func must not block or return the mutable form outside of this routine.

abstract suspend operator override fun <U> invoke(func: MutableValue<T>.() -> U): U

isBound

Return true if this object is already bound.

open override fun isBound(): Boolean

readOnly

Return an unmodifiable form of this WatchableSet.

abstract override fun readOnly(): ReadOnlyWatchableValue<T>

set

Replace the old value with value.

abstract suspend fun set(value: T)

toString

open override fun toString(): String

twoWayBind

Bind other to this so that any change in either object is reflected in the other.

abstract override fun twoWayBind(scope: CoroutineScope, other: MutableWatchable<MutableValue<T>, ValueChange<T>>): Watcher

abstract override fun <M2, C2 : Change> twoWayBind(scope: CoroutineScope, other: MutableWatchable<M2, C2>, update: MutableValue<T>.(C2) -> Unit, updateOther: M2.(ValueChange<T>) -> Unit): Watcher

unbind

Remove any existing binding for this object.

abstract override fun unbind()

waitFor

open suspend override fun waitFor(scope: CoroutineScope, func: () -> Boolean)

watch

open override fun watch(scope: CoroutineScope, period: Long, func: SuspendFunction1<ValueChange<T>, Unit>): Watcher

Properties

boundTo

The Watchable to which this object is bound, if any.

abstract override val boundTo: Watchable<*>?

value

Direct access to the current value inside the container.

abstract override val value: T