forked from monix/monix
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrootdoc.txt
32 lines (29 loc) · 1.81 KB
/
rootdoc.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<img src="https://monix.io/public/images/monix-logo.png" align="right" width="200" />
This is the API documentation for the [[https://monix.io Monix]] library.
==Package Overview==
- [[monix.execution]] exposes lower level primitives for dealing
with asynchronous execution
- [[monix.execution.atomic]] exposes the `Atomic` types, as alternative
to `java.util.concurrent.atomic`
- [[monix.execution.cancelables]] contains several
useful [[monix.execution.Cancelable Cancelable]] implementations
- [[monix.execution.schedulers]] contains several
useful [[monix.execution.Scheduler Scheduler]] implementations
- [[monix.execution.rstreams]] contains helpers for dealing
with the [[http://www.reactive-streams.org Reactive Streams]] specification
- [[monix.eval]] is for dealing with evaluation of results, thus exposing
[[monix.eval.Task Task]] and [[monix.eval.Coeval Coeval]]
- [[monix.reactive]] exposes the `Observable` pattern
- [[monix.reactive.exceptions]] groups some exceptions thrown by the implementation
- [[monix.reactive.observables]] groups reusable `Observable` implementations
- [[monix.reactive.observers]] groups reusable [[monix.reactive.Observer Observer]]
implementations
- [[monix.reactive.subjects]] exposes [[monix.reactive.subjects.Subject Subject]]
and [[monix.reactive.subjects.ConcurrentSubject ConcurrentSubject]],
which are implementations of hot observables that function both as input and output
- [[monix.types]] implements type-class shims, to be translated to
type-classes provided by libraries such as
[[http://typelevel.org/cats/ Cats]] or [[http://scalaz.org/ Scalaz]]
- [[monix.cats]] is the optional integration with the
[[http://typelevel.org/cats/ Cats]] library, providing translations
for the types described in `monix.types`