Package org.brightify.hyperdrive.multiplatformx.property

Types

DeferredObservableProperty

interface DeferredObservableProperty<T>

This interface is an asynchronous variation to the ObservableProperty.

MutableObservableProperty

interface MutableObservableProperty<T> : ObservableProperty<T>

ObservableProperty with the added functionality of a mutable value.

ObservableProperty

interface ObservableProperty<T>

A synchronous property delegate accessor.

ValueChangeListener

interface ValueChangeListener<OLD, NEW>

Implemented by listeners to observe ObservableProperty and DeferredObservableProperty value changes.

ViewModelProperty

typealias ViewModelProperty<T> = ObservableProperty<T>

Functions

asChannel

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

Conversion method to Channel.

asFlow

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

Conversion method to Flow.

combine

fun <T> combine(sources: List<ObservableProperty<T>>): ObservableProperty<List<T>>

Combine the last values of all provided ObservableProperty into a list of values.

fun <T1, T2> combine(source1: ObservableProperty<T1>, source2: ObservableProperty<T2>, equalityPolicy: ObservableProperty.EqualityPolicy<Pair<T1, T2>> = defaultEqualityPolicy()): ObservableProperty<Pair<T1, T2>>

Combine the last values of two ObservableProperty into a Pair.

fun <T1, T2, U> combine(source1: ObservableProperty<T1>, source2: ObservableProperty<T2>, equalityPolicy: ObservableProperty.EqualityPolicy = defaultEqualityPolicy(), combine: (T1, T2) -> U): ObservableProperty

Combine the last values of two ObservableProperty with a mapping function.

fun <T1, T2, T3, U> combine(source1: ObservableProperty<T1>, source2: ObservableProperty<T2>, source3: ObservableProperty<T3>, equalityPolicy: ObservableProperty.EqualityPolicy<Triple<T1, T2, T3>> = defaultEqualityPolicy()): ObservableProperty<Triple<T1, T2, T3>>

Combine the last values of three ObservableProperty into a Triple.

fun <T1, T2, T3, U> combine(source1: ObservableProperty<T1>, source2: ObservableProperty<T2>, source3: ObservableProperty<T3>, equalityPolicy: ObservableProperty.EqualityPolicy = defaultEqualityPolicy(), combine: (T1, T2, T3) -> U): ObservableProperty

Combine the last values of three ObservableProperty with a mapping function.

fun <T1, T2, T3, T4, U> combine(source1: ObservableProperty<T1>, source2: ObservableProperty<T2>, source3: ObservableProperty<T3>, source4: ObservableProperty<T4>, equalityPolicy: ObservableProperty.EqualityPolicy = defaultEqualityPolicy(), combine: (T1, T2, T3, T4) -> U): ObservableProperty

Combine the last values of four ObservableProperty with a mapping function.

fun <T1, T2, T3, T4, T5, U> combine(source1: ObservableProperty<T1>, source2: ObservableProperty<T2>, source3: ObservableProperty<T3>, source4: ObservableProperty<T4>, source5: ObservableProperty<T5>, equalityPolicy: ObservableProperty.EqualityPolicy = defaultEqualityPolicy(), combine: (T1, T2, T3, T4, T5) -> U): ObservableProperty

Combine the last values of five ObservableProperty with a mapping function.

constant

fun <T> ObservableProperty.Companion.constant(value: T): ObservableProperty<T>

defaultEqualityPolicy

fun <T> defaultEqualityPolicy(): ObservableProperty.EqualityPolicy<T>

Create an equality policy using the default T.

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>

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

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> DeferredObservableProperty<T>.flatMapLatest(equalityPolicy: ObservableProperty.EqualityPolicy<DeferredObservableProperty> = identityEqualityPolicy(), transform: (T) -> DeferredObservableProperty): DeferredObservableProperty

A mapping function applied to each element collected from the ObsrvableProperty to return a DeferredObservableProperty.

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.

identityEqualityPolicy

fun <T> identityEqualityPolicy(): ObservableProperty.EqualityPolicy<T>

Create an equality policy that returns true only if the values are identical, not just equal.

map

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

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

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.

merge

fun <T> merge(sources: List<ObservableProperty<T>>): DeferredObservableProperty<T>

mergeDeferred

fun <T> mergeDeferred(sources: List<DeferredObservableProperty<T>>): DeferredObservableProperty<T>

MutableObservableProperty

fun <T> MutableObservableProperty(initialValue: T, equalityPolicy: ObservableProperty.EqualityPolicy<T> = defaultEqualityPolicy()): MutableObservableProperty<T>

never

fun <T> ObservableProperty.Companion.never(): DeferredObservableProperty<T>

neverEqualPolicy

fun <T> neverEqualPolicy(): ObservableProperty.EqualityPolicy<T>

Create an equality policy that always returns false (values are never equal).

nextValue

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

Block current thread in wait for the next value change.

startWith

fun <T> DeferredObservableProperty<T>.startWith(initialValue: T): ObservableProperty<T>

Conversion method to synchronous ObservableProperty.