Snail-Kotlin
🐌
A lightweight observables framework, also available in Swift
Download
You can download a jar from GitHub's releases page.
Jitpack
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
dependencies {
compile 'com.github.urbancompass:snail-kotlin:x.x.x'
}
Creating Observables
val observable = Observable<thing>()
Subscribing to Observables
observable.subscribe(
next = { thing in ... }, // do something with thing
error = { error in ... }, // do something with error
done = { ... } // do something when it's done
)
Closures are optional too...
observable.subscribe(
next = { thing in ... } // do something with thing
)
observable.subscribe(
error = { error in ... } // do something with error
)
Creating Observables Variables
val variable = Variable<whatever>(some initial value)
val optionalString = Variable<String?>(null)
optionalString.asObservable().subscribe(
next = { string in ... } // do something with value changes
)
optionalString.value = "something"
val int = Variable<Int>(12)
int.asObservable().subscribe(
next = { int in ... } // do something with value changes
)
int.value = 42
Miscellaneous Observables
val just = Just(1) // always returns the initial value (1 in this case)
val failure = Fail(RunTimeException()) // always returns error
failure.subscribe(
error = { it } //it is RuntimeException
)
val n = 5
let replay = Replay(n) // replays the last N events when a new observer subscribes
Dispatchers
You can specify which dispatcher an observables will be notified on by using .subscribe(dispatcher: <desired dispatcher>). If you don't specify, then the observable will be notified on the same dispatcher that the observable published on.
There are 3 scenarios:
-
You don't specify the dispatcher. Your observer will be notified on the same dispatcher as the observable published on.
-
You specified
Maindispatcher AND the observable published on theMaindispatcher. Your observer will be notified synchronously on theMaindispatcher. -
You specified a dispatcher. Your observer will be notified async on the specified dispatcher.
Examples
Subscribing on Main
observable.subscribe(Dispatchers.Main, next = {
// do stuff with it...
})
413 Dec 5, 2022
28 Nov 1, 2022
819 Dec 29, 2022
3 Nov 15, 2022
10.7k Jan 9, 2023
4 Nov 10, 2022
31 Nov 29, 2021
1.6k Jan 8, 2023
1 Nov 16, 2021
8 Nov 26, 2022
8 Nov 24, 2022
2 Aug 12, 2022
1.5k Dec 30, 2022
0 Jan 20, 2022
98 Dec 15, 2022
1.5k Jan 3, 2023
20 Nov 9, 2021
28 Dec 10, 2022
35 Jul 23, 2022