actual abstract class BaseSubject<R : T, T, OO : ObservableOptional<R>>(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>) : AbstractBaseSubject<R, T, OO>

An abstract class that extends AbstractBaseSubject.

expect abstract class BaseSubject<R : T, T, OO : ObservableOptional<R>>(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>) : AbstractBaseSubject<R, T, OO>

An abstract class that extends AbstractBaseSubject.

actual abstract class BaseSubject<R : T, T, OO : ObservableOptional<R>>

An abstract class that extends AbstractBaseSubject.

actual abstract class BaseSubject<R : T, T, OO : ObservableOptional<R>>(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>) : AbstractBaseSubject<R, T, OO>

An abstract class that extends AbstractBaseSubject.

actual abstract class BaseSubject<R : T, T, OO : ObservableOptional<R>>(observation: Observation<R, T, OO>, stateFlowToBind: suspend () -> StateFlow<R?>) : AbstractBaseSubject<R, T, OO>

An abstract class that extends AbstractBaseSubject.

BaseUninitializedObservable

abstract class BaseUninitializedObservable<T>(observation: ObservationUninitialized<T>) : BaseObservable<T, T, ObservableOptional<T>> , UninitializedObservable<T> , Uninitialized<T>

An abstract class extending BaseObservable that implements UninitializedObservable

BaseUninitializedSubject

actual abstract class BaseUninitializedSubject<T>(observation: ObservationUninitialized<T>) : AbstractBaseUninitializedSubject<T>

An abstract class extending AbstractBaseUninitializedSubject.

expect abstract class BaseUninitializedSubject<T>(observation: ObservationUninitialized<T>) : AbstractBaseUninitializedSubject<T>

An abstract class extending AbstractBaseUninitializedSubject.

actual abstract class BaseUninitializedSubject<T>

An abstract class extending AbstractBaseUninitializedSubject.

actual abstract class BaseUninitializedSubject<T>(observation: ObservationUninitialized<T>) : AbstractBaseUninitializedSubject<T>

An abstract class extending AbstractBaseUninitializedSubject.

actual abstract class BaseUninitializedSubject<T>(observation: ObservationUninitialized<T>) : AbstractBaseUninitializedSubject<T>

An abstract class extending AbstractBaseUninitializedSubject.

BasicObservable

interface BasicObservable<R : T, T, OO : ObservableOptional<R>> : ReadOnlyProperty<Any?, OO> , Initial<R, T>

A read-only property that can be observed.

BasicSubject

interface BasicSubject<R : T, T, OO : ObservableOptional<R>> : BasicObservable<R, T, OO> , SuspendableSetter<T>

A read-write property that can be observed. The value that can be changed using the post method from the Postable interface

DefaultFlowObservable

class DefaultFlowObservable<R : T?, T>(defaultValue: R, initialValue: T? = defaultValue, coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, flow: Flow<T?>, observation: ObservationDefault<R, T?> = ObservationDefault( defaultValue, ObservableOptional.Value(initialValue), )) : BaseDefaultObservable<R, T?>

A BaseDefaultObservable that observes the state of a Flow.

DefaultInitialized

interface DefaultInitialized<R : T?, T> : Initialized<R, T?>

An Initialized that has a defaultValue

DefaultObservable

interface DefaultObservable<R : T?, T> : BasicObservable<R, T?, ObservableOptional.Value<R>> , DefaultInitialized<R, T?>

A BasicObservable that is DefaultInitialized

DefaultSubject

interface DefaultSubject<R : T?, T> : BasicSubject<R, T?, ObservableOptional.Value<R>> , DefaultObservable<R, T> , MutableDefaultInitialized<R, T?>

A BasicSubject that is DefaultInitialized

Disposable

interface Disposable

Reference to an object that should be disposed in time

DisposeBag

class DisposeBag : Disposable

Container for multiple Disposable. Allows nested DisposeBag.

DisposeHandler

typealias DisposeHandler = () -> Unit

FlowInitializedObservable

class FlowInitializedObservable<T>(initialValue: T, val coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, val flow: Flow<T>, observation: ObservationInitialized<T> = ObservationInitialized(initialValue)) : BaseInitializedObservable<T>

A BaseInitializedObservable that observes the state of a Flow

FlowObservable

class FlowObservable<T>(val coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, val flow: Flow<T>, observation: ObservationUninitialized<T> = ObservationUninitialized()) : BaseUninitializedObservable<T>

A BaseUninitializedObservable that observes the state of a Flow

Initial

interface Initial<R : T, T>

Marks a class that has an initial ObservableOptional value, where T is the expected input value and R is its result.

Initialized

interface Initialized<R : T, T> : Initial<R, T> , WithState<R>

An Initial that has Value as its initialValue

InitializedObservable

interface InitializedObservable<T> : BasicObservable<T, T, ObservableOptional.Value<T>> , Initialized<T, T>

A BaseObservable that is Initialized.

InitializedSubject

interface InitializedSubject<T> : BasicSubject<T, T, ObservableOptional.Value<T>> , InitializedObservable<T> , MutableInitialized<T, T>

A BasicSubject that is Initialized

MutableDefaultInitialized

interface MutableDefaultInitialized<R : T?, T> : DefaultInitialized<R, T?> , WithMutableState<R>

A DefaultInitialized that implements WithMutableState

MutableInitialized

interface MutableInitialized<R : T, T> : Initialized<R, T> , WithMutableState<R>

An Initialized that implements WithMutableState

MutableUninitialized

interface MutableUninitialized<T> : Uninitialized<T> , WithMutableState<T?>

An Uninitialized that implements WithMutableState

ObservableOptional

sealed class ObservableOptional<T> : ReadOnlyProperty<Any?, T?>

Result type for a BaseObservable. Used to allow for the distinction between null and optional values.

Observation

open class Observation<R : T, T, OO : ObservableOptional<R>>(val initialValue: ObservableOptional<T>) : Initial<R, T>

Class that handles observing value changes for a value of a given type

ObservationDefault

open class ObservationDefault<R : T?, T>(val defaultValue: ObservableOptional.Value<R>, val initialValue: ObservableOptional.Value<T?>) : Observation<R, T?, ObservableOptional.Value<R>> , ReadWriteProperty<Any?, R> , MutableDefaultInitialized<R, T?>

An Observation that implements MutableDefaultInitialized

ObservationInitialized

open class ObservationInitialized<T>(val initialValue: ObservableOptional.Value<T>) : Observation<T, T, ObservableOptional.Value<T>> , ReadWriteProperty<Any?, T> , MutableInitialized<T, T>

An Observation that implements MutableInitialized

ObservationUninitialized

class ObservationUninitialized<T> : Observation<T, T, ObservableOptional<T>> , MutableUninitialized<T> , ReadWriteProperty<Any?, T?>

An Observation that implements MutableUninitialized

PlatformSubjectObserver

actual interface PlatformSubjectObserver<R>

expect interface PlatformSubjectObserver<R>

actual interface PlatformSubjectObserver<R>

Postable

interface Postable<T>

A Postable can handle values being posted to it.

ReadOnlyPropertyDefaultObservable

class ReadOnlyPropertyDefaultObservable<R : T?, T>(defaultValue: R, readOnlyProperty: ReadOnlyProperty<Any?, T>, observation: ObservationDefault<R, T?> = ObservationDefault( defaultValue, ObservableOptional.Value( run { val v by readOnlyProperty v }, ), )) : BaseDefaultObservable<R, T>

A BaseDefaultObservable that matches its value to a ReadOnlyProperty. When the ReadOnlyProperty updates, changes to the property are not immediately delegated back to the observable. Use a Flow based observable if synchronized values are required

ReadOnlyPropertyInitializedObservable

class ReadOnlyPropertyInitializedObservable<T>(readOnlyProperty: ReadOnlyProperty<Any?, T>, observation: ObservationInitialized<T> = ObservationInitialized( ObservableOptional.Value( run { val v by readOnlyProperty v }, ), )) : BaseInitializedObservable<T> , InitializedObservable<T>

A BaseInitializedObservable that matches its value to a ReadOnlyProperty. When the ReadOnlyProperty updates, changes to the property are not immediately delegated back to the observable. Use a Flow based observable if synchronized values are required.

ReadWritePropertyDefaultSubject

class ReadWritePropertyDefaultSubject<R : T?, T>(defaultValue: R, readWriteProperty: ReadWriteProperty<Any?, T?>, initialValue: ObservableOptional.Value<T?> = Value( run { val v by readWriteProperty v }, ), coroutineScope: CoroutineScope?, context: CoroutineContext? = coroutineScope?.coroutineContext, observation: ObservationDefault<R, T?> = ObservationDefault(defaultValue, initialValue)) : BaseDefaultSubject<R, T> , SuspendableSetter<T?>

A BaseDefaultSubject that matches its value to a ReadWriteProperty. When the ReadWriteProperty updates, changes to the property are not immediately delegated back to the subject. Use a Flow based subject if synchronized values are required

ReadWritePropertyInitializedSubject

class ReadWritePropertyInitializedSubject<T>(readWriteProperty: ReadWriteProperty<Any?, T>, initialValue: ObservableOptional.Value<T> = Value( run { val v by readWriteProperty v }, ), coroutineScope: CoroutineScope?, context: CoroutineContext? = coroutineScope?.coroutineContext, observation: ObservationInitialized<T> = ObservationInitialized(initialValue)) : BaseInitializedSubject<T> , SuspendableSetter<T>

A BaseInitializedSubject that matches its value to a ReadWriteProperty. When the ReadWriteProperty updates, changes to the property are not immediately delegated back to the subject. Use a Flow based subject if synchronized values are required

SharedFlowDefaultSubject

open class SharedFlowDefaultSubject<R : T?, T>(defaultValue: R, initialValue: T? = defaultValue, coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, sharedFlow: MutableSharedFlow<T?>, autoBind: Boolean = true, observation: ObservationDefault<R, T?> = ObservationDefault( defaultValue, ObservableOptional.Value(initialValue), )) : BaseDefaultSubject<R, T?> , SuspendableSetter<T?>

A BaseDefaultSubject that matches the state of a MutableSharedFlow.

SharedFlowInitializedSubject

open class SharedFlowInitializedSubject<T>(initialValue: T, coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, sharedFlow: MutableSharedFlow<T>, autoBind: Boolean = true, observation: ObservationInitialized<T> = ObservationInitialized(initialValue)) : BaseInitializedSubject<T> , SuspendableSetter<T>

A BaseInitializedSubject that matches the state of a MutableSharedFlow.

SharedFlowSubject

open class SharedFlowSubject<T>(coroutineScope: CoroutineScope, context: CoroutineContext = coroutineScope.coroutineContext, sharedFlow: MutableSharedFlow<T>, autoBind: Boolean = true, observation: ObservationUninitialized<T> = ObservationUninitialized()) : BaseUninitializedSubject<T> , SuspendableSetter<T>

A BaseUninitializedSubject that matches the state of a MutableSharedFlow.

SimpleDefaultSubject

class SimpleDefaultSubject<R : T?, T>(defaultValue: R, initialValue: T? = defaultValue) : BaseDefaultSubject<R, T?>

A BaseDefaultSubject that initialized to a given value.

SimpleDisposable

actual class SimpleDisposable(onDispose: DisposeHandler) : BaseSimpleDisposable

A Disposable that has a DisposeHandler

expect class SimpleDisposable(onDispose: DisposeHandler) : BaseSimpleDisposable

A Disposable that has a DisposeHandler

actual class SimpleDisposable

A Disposable that has a DisposeHandler

actual class SimpleDisposable(onDispose: DisposeHandler) : BaseSimpleDisposable

A Disposable that has a DisposeHandler

actual class SimpleDisposable(onDispose: DisposeHandler) : BaseSimpleDisposable

A Disposable that has a DisposeHandler

SimpleInitializedObservable

class SimpleInitializedObservable<T>(value: T) : BaseInitializedObservable<T>

A BaseInitializedObservable that has a fixed value.

SimpleInitializedSubject

class SimpleInitializedSubject<T>(observation: ObservationInitialized<T>) : BaseInitializedSubject<T>

A BaseInitializedSubject that initialized to a given value.

StateFlowDefaultSubject

open class StateFlowDefaultSubject<R : T?, T>(defaultValue: R, val coroutineScope: CoroutineScope, val context: CoroutineContext = coroutineScope.coroutineContext, observedStateFlow: MutableStateFlow<T?>, autoBind: Boolean = true, observation: ObservationDefault<R, T?> = ObservationDefault( defaultValue, ObservableOptional.Value(observedStateFlow.value), )) : BaseDefaultSubject<R, T?> , SuspendableSetter<T?>

A BaseDefaultSubject that matches the state of a MutableStateFlow.

StateFlowInitializedSubject

open class StateFlowInitializedSubject<T>(val coroutineScope: CoroutineScope, val context: CoroutineContext = coroutineScope.coroutineContext, observedStateFlow: MutableStateFlow<T>, autoBind: Boolean = true, observation: ObservationInitialized<T> = ObservationInitialized( ObservableOptional.Value( observedStateFlow.value, ), )) : BaseInitializedSubject<T> , SuspendableSetter<T>

A BaseInitializedSubject that matches the state of a MutableStateFlow.

SuspendableSetter

interface SuspendableSetter<T> : Postable<T>

A Postable that can be set in a suspended manner.

Uninitialized

interface Uninitialized<T> : Initial<T, T> , WithState<T?>

An Initial that has Nothing as its initialValue

UninitializedObservable

interface UninitializedObservable<T> : BasicObservable<T, T, ObservableOptional<T>> , Uninitialized<T>

A BasicObservable that is Uninitialized.

UninitializedSubject

interface UninitializedSubject<T> : BasicSubject<T, T, ObservableOptional<T>> , UninitializedObservable<T> , MutableUninitialized<T>

A BasicSubject that is Uninitialized

WithMutableState

interface WithMutableState<T> : WithState<T>

A WithState where stateFlow is mutable

WithState

actual interface WithState<T>