package cancelables
- Alphabetic
- Public
- All
Type Members
- trait AssignableCancelableF[F[_]] extends CancelableF[F]
Represents a class of cancelable references that can hold an internal reference to another cancelable (and thus has to support the assignment operator).
Represents a class of cancelable references that can hold an internal reference to another cancelable (and thus has to support the assignment operator).
On assignment, if this cancelable is already canceled, then no assignment should happen and the update reference should be canceled as well.
- trait BooleanCancelableF[F[_]] extends CancelableF[F]
Represents a CancelableF that can be queried for the canceled status.
Represents a CancelableF that can be queried for the canceled status.
- See also
monix.execution.cancelables.BooleanCancelable for the simpler, side-effecting version.
- final class SingleAssignCancelableF[F[_]] extends Bool[F]
Represents a monix.catnap.CancelableF that can be assigned only once to another cancelable reference.
Represents a monix.catnap.CancelableF that can be assigned only once to another cancelable reference.
If the assignment happens after this cancelable has been canceled, then on assignment the reference will get canceled too. If the assignment already happened, then a second assignment will raise an error.
Useful in case you need a forward reference.
Value Members
- object AssignableCancelableF
- object BooleanCancelableF
- object SingleAssignCancelableF
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomictypes, as alternative tojava.util.concurrent.atomicmonix.catnap exposes pure abstractions built on top of the Cats-Effect type classes:
monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observablepattern:Observableimplementationsmonix.tail exposes Iterant for purely functional pull based streaming:
BatchandBatchCursor, the alternatives to Scala'sIterableandIteratorrespectively that we are using within Iterant's encodingYou 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.