trait Bool[F[_]] extends AssignableCancelableF[F] with BooleanCancelableF[F]
Represents AssignableCancelableF instances that are also BooleanCancelableF.
Linear Supertypes
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- Bool
- BooleanCancelableF
- AssignableCancelableF
- CancelableF
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Abstract Value Members
- abstract def cancel: CancelToken[F]
- Definition Classes
- CancelableF
- abstract def isCanceled: F[Boolean]
- returns
true in case this cancelable hasn't been canceled, or false otherwise.
- Definition Classes
- BooleanCancelableF
- abstract def set(cancelable: CancelableF[F]): F[Unit]
Sets the underlying reference to the given CancelableF reference.
Sets the underlying reference to the given CancelableF reference.
Contract:
- the given reference gets canceled in case the assignable was already canceled
- this operation might throw an error if the contract of the
implementation doesn't allow for calling
setmultiple times (e.g. SingleAssignCancelableF)
- Definition Classes
- AssignableCancelableF
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.