Packages

package root

This is the API documentation for the 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 Cancelable implementations
monix.execution.schedulers contains several useful Scheduler implementations
monix.execution.rstreams contains helpers for dealing with the Reactive Streams specification
monix.execution.misc provides miscellaneous primitives useful for dealing with concurrency
monix.execution.exceptions groups some exceptions thrown by the implementation

monix.catnap exposes pure abstractions built on top of the Cats-Effect type classes:

monix.catnap.cancelables exposes pure counterparts to the cancelable data types described in monix.execution.cancelables

monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.

monix.reactive exposes the Observable pattern:

monix.reactive.observables groups reusable Observable implementations
monix.reactive.observers groups reusable Observer implementations
monix.reactive.subjects exposes Subject and ConcurrentSubject, which are implementations of hot observables that function both as input and output

monix.tail exposes Iterant for purely functional pull based streaming:

monix.tail.batches describes Batch and BatchCursor, the alternatives to Scala's Iterable and Iterator respectively that we are using within Iterant's encoding

You can control evaluation with type you choose - be it Task, Coeval, cats.effect.IO or your own as long as you provide correct cats-effect or cats typeclass instance.