multiplatformx-api/org.brightify.hyperdrive.multiplatformx.property/ObservableProperty

ObservableProperty

interface ObservableProperty<T>

A synchronous property delegate accessor.

NOTE: DeferredObservableProperty is the asynchronous variation lacking initial value.

Types

Companion

object Companion

EqualityPolicy

fun interface EqualityPolicy<T>

This interface is used to provide custom equality for various ObservableProperty operators like ObservableProperty.map and ObservableProperty.filter.

Listener

interface Listener<T> : ValueChangeListener<T, T>

Implemented by listeners to ObservableProperty value changes.

Functions

addListener

abstract fun addListener(listener: ObservableProperty.Listener<T>): CancellationToken

Add a ValueChangeListener for value change on this property.

removeListener

abstract fun removeListener(listener: ObservableProperty.Listener<T>)

Remove a ValueChangeListener from listeners to value change on this property.

Properties

value

abstract val value: T

Currently assigned value.

Inheritors

MutableObservableProperty

Extensions

asChannel

fun <T> ObservableProperty<T>.asChannel(): Channel<T>

Conversion method to Channel.

asFlow

fun <T> ObservableProperty<T>.asFlow(): Flow<T>

Conversion method to Flow.

deferred

fun <T> ObservableProperty<T>.deferred(): DeferredObservableProperty<T>

Conversion method to asynchronous DeferredObservableProperty.

filter

fun <T> ObservableProperty<T>.filter(equalityPolicy: ObservableProperty.EqualityPolicy<T> = defaultEqualityPolicy(), predicate: (T) -> Boolean): DeferredObservableProperty<T>

fun <T> ObservableProperty<T>.filter( initialValue: T, equalityPolicy: ObservableProperty.EqualityPolicy<T> = defaultEqualityPolicy(), predicate: (T) -> Boolean): ObservableProperty<T>

A filter function applied to each element collected from the ObservableProperty.

filterNotNull

fun <T : Any> ObservableProperty<T?>.filterNotNull(equalityPolicy: ObservableProperty.EqualityPolicy<T> = defaultEqualityPolicy()): DeferredObservableProperty<T>

Keep each non-null element collected from the ObservableProperty.

flatMapLatest

fun <T, U> ObservableProperty<T>.flatMapLatest(equalityPolicy: ObservableProperty.EqualityPolicy<ObservableProperty> = identityEqualityPolicy(), transform: (T) -> ObservableProperty): ObservableProperty

A mapping function applied to each element collected from the ObservableProperty to return another ObservableProperty.

map

fun <T, U> ObservableProperty<T>.map(equalityPolicy: ObservableProperty.EqualityPolicy = defaultEqualityPolicy(), transform: (T) -> U): ObservableProperty

A mapping function applied to each element collected from the ObservableProperty.

nextValue

suspend fun <T> ObservableProperty<T>.nextValue(): T

Block current thread in wait for the next value change.