final class SingleAssignCancelableF[F[_]] extends Bool[F]
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.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- SingleAssignCancelableF
- Bool
- BooleanCancelableF
- AssignableCancelableF
- CancelableF
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Value Members
- val cancel: CancelToken[F]
- Definition Classes
- SingleAssignCancelableF → CancelableF
- val isCanceled: F[Boolean]
- returns
true in case this cancelable hasn't been canceled, or false otherwise.
- Definition Classes
- SingleAssignCancelableF → BooleanCancelableF
- def set(ref: 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
- SingleAssignCancelableF → 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.