rd-core/com.jetbrains.rd.util.reactive/IOptProperty

IOptProperty

interface IOptProperty<T : Any> : IOptPropertyView<T> , IMutablePropertyBase<T>

A mutable property that is created in an uninitialized state.

Inheritors

OptProperty

WriteOnceProperty

Properties

change

abstract val change: ISource<T>

Allows to subscribe to subsequent changes of the property value. Unlike subscribing to the property directly, the callback will not be immediately called with the current value of the property.

changing

open val changing: Boolean

hasTrueValue

val IOptPropertyView<Boolean>.hasTrueValue: Boolean

hasValue

val <T : Any> IOptPropertyView<T>.hasValue: Boolean

Evaluates to true if the property has an initialized value.

valueOrNull

abstract val valueOrNull: T?

Returns the current value of the property, or null if the property has not been initialized.

valueOrThrow

val <T : Any> IOptPropertyView<T>.valueOrThrow: T

Returns the value of the property, or throws an exception if it was not initialized.

Functions

advise

open override fun advise(lifetime: Lifetime, handler: (T) -> Unit)

Adds an event subscription. Every time an event occurs, the handler is called, receiving an instance of the event. The subscription is removed when the given lifetime expires.

advise

fun IVoidSource.advise(lifetime: Lifetime, handler: () -> Unit)

adviseEternal

fun <T> ISource<T>.adviseEternal(handler: (T) -> Unit)

Adds an event subscription that never gets removed.

adviseNotNull

fun <T : Any> ISource<T?>.adviseNotNull(lifetime: Lifetime, handler: (T) -> Unit)

Adds an event subscription that filters out null values.

adviseNotNullOnce

fun <T : Any> ISource<T?>.adviseNotNullOnce(lifetime: Lifetime, handler: (T) -> Unit): LifetimeDefinition

Executes handler exactly once when the source fires an event with a non-null value, then terminates the subscription

adviseOnce

fun <T> ISource<T>.adviseOnce(lifetime: Lifetime, handler: (T) -> Unit)

Executes handler exactly once then terminates the subscription

adviseSuspend

fun <T> ISource<T>.adviseSuspend(lifetime: Lifetime, scheduler: IScheduler, handler: suspend (T) -> Unit)

fun <T> ISource<T>.adviseSuspend(lifetime: Lifetime, context: CoroutineContext, handler: suspend (T) -> Unit)

adviseUntil

fun <T> ISource<T>.adviseUntil(lifetime: Lifetime, handler: (T) -> Boolean)

Holds subscription until handler returns true or lifetime is terminated

adviseWithPrev

fun <T> ISource<T>.adviseWithPrev(lifetime: Lifetime, handler: (prev: Maybe<T>, cur: T) -> Unit)

and

fun IOptPropertyView<Boolean>.and(other: IOptPropertyView<Boolean>): IOptPropertyView<Boolean>

asNullable

fun <T : Any> IOptPropertyView<T>.asNullable(): IPropertyView<T?>

Converts an optional property to a non-optional property with a nullable value type.

asProperty

fun <T> ISource<T>.asProperty(defaultValue: T): IPropertyView<T>

bind

fun <T> IMutablePropertyBase<T>.bind(lifetime: Lifetime, setValue: (value: T) -> Unit, valueUpdated: ((value: T) -> Unit) -> Unit)

compose

fun <T1 : Any, T2 : Any, TRes : Any> IOptPropertyView<T1>.compose(other: IOptPropertyView<T2>, composer: (T1, T2) -> TRes): IOptPropertyView<TRes>

distinct

fun <T> ISource<T>.distinct(): ISource<T>

filter

fun <T> ISource<T>.filter(f: (T) -> Boolean): ISource<T>

flowInto

fun <TSrc> ISource<TSrc>.flowInto(lifetime: Lifetime, target: IMutablePropertyBase<TSrc>)

fun <TSrc : Any, TDst : Any> ISource<IViewableList.Event<TSrc>>.flowInto(lifetime: Lifetime, target: IMutableViewableList<TDst>, tf: (TSrc) -> TDst)

fun <TKey : Any, TValue : Any> ISource<IViewableMap.Event<TKey, TValue>>.flowInto(lifetime: Lifetime, target: IMutableViewableMap<TKey, TValue>, tf: (TValue) -> TValue)

fun <TSrc : Any, TDst : Any> ISource<IViewableSet.Event<TSrc>>.flowInto(lifetime: Lifetime, target: IMutableViewableSet<TDst>, tf: (TSrc) -> TDst)

fun <T> ISource<T>.flowInto(lifetime: Lifetime, target: ISignal<T>)

Whenever a change happens in this source, fires a change in the target signal of the same type.

fun <TSrc, TDst> ISource<TSrc>.flowInto(lifetime: Lifetime, target: IMutablePropertyBase<TDst>, tf: (TSrc) -> TDst)

Whenever a change happens in this source, changes the target property of the same type.

fun <TSource, TTarget> ISource<TSource>.flowInto(lifetime: Lifetime, target: ISignal<TTarget>, tf: (TSource) -> TTarget)

Whenever a change happens in this source, fires a change in the target signal obtained by running the given tf function.

map

fun <T : Any, R : Any> IOptPropertyView<T>.map(f: (T) -> R): IOptPropertyView<R>

fun <T, R> ISource<T>.map(f: (T) -> R): ISource<R>

Returns a new source which remaps events happening in this source using the given function f.

nextFalseValue

suspend fun ISource<Boolean>.nextFalseValue(): Boolean

nextFalseValueAsync

fun ISource<Boolean>.nextFalseValueAsync(lifetime: Lifetime): Deferred<Boolean>

nextNotNullValue

suspend fun <T : Any> ISource<T?>.nextNotNullValue(): T

nextNotNullValueAsync

fun <T : Any> ISource<T?>.nextNotNullValueAsync(lifetime: Lifetime): Deferred<T>

nextTrueValue

suspend fun ISource<Boolean>.nextTrueValue(): Boolean

nextTrueValueAsync

fun ISource<Boolean>.nextTrueValueAsync(lifetime: Lifetime): Deferred<Boolean>

nextValue

suspend fun <T> ISource<T>.nextValue(condition: (T) -> Boolean = { true }): T

nextValueAsync

fun <T> ISource<T>.nextValueAsync(lifetime: Lifetime, condition: (T) -> Boolean = { true }): Deferred<T>

not

fun IOptPropertyView<Boolean>.not(): IOptPropertyView<Boolean>

fun IOptPropertyView<Boolean>.or(other: IOptPropertyView<Boolean>): IOptPropertyView<Boolean>

set

abstract fun set(newValue: T)

Sets the property to the given value.

throttleLast

fun <T : Any> ISource<T>.throttleLast(timeout: Duration, scheduler: IScheduler): ISource<T>

valueOrDefault

fun <T : Any> IOptProperty<T>.valueOrDefault(default: T): T

Returns the value of the property, or the given default value if the property was not initialized.

view

open override fun view(lifetime: Lifetime, handler: (Lifetime, T) -> Unit)

Adds a subscription to changes of the contents of the object.

viewNotNull

fun <T : Any> IViewable<T?>.viewNotNull(lifetime: Lifetime, handler: (Lifetime, T) -> Unit)

Adds a subscription to changes to this viewable's contents and filters out null values. The subscription is removed when the given lifetime expires.

whenFalse

fun IViewable<Boolean>.whenFalse(lifetime: Lifetime, action: (Lifetime) -> Unit)

Executes the given action every time the value of the property changes to false.

whenTrue

fun IViewable<Boolean>.whenTrue(lifetime: Lifetime, action: (Lifetime) -> Unit)

Executes the given action every time the value of the property changes to true.