object BooleanCancelableF
- Source
- BooleanCancelableF.scala
- Alphabetic
- By Inheritance
- BooleanCancelableF
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- def alreadyCanceled[F[_]](implicit F: Applicative[F]): BooleanCancelableF[F] with Empty[F]
Returns an instance of a BooleanCancelableF that's already canceled.
- def apply[F[_]](token: CancelToken[F])(implicit F: Sync[F]): F[BooleanCancelableF[F]]
Builder for BooleanCancelableF that wraps and protects the given cancellation token.
Builder for BooleanCancelableF that wraps and protects the given cancellation token.
The returned implementation guarantees idempotency by ensuring that the given
tokenwill only be executed once, the operation becoming a no-op on sub-sequent evaluations, thus being memoized.- token
is a value that can be evaluated.
- def dummy[F[_]](implicit F: Applicative[F]): BooleanCancelableF[F]
Returns a BooleanCancelableF that can never be canceled.
Returns a BooleanCancelableF that can never be canceled.
Useful as a low-overhead instance whose
isCanceledvalue is alwaysfalse, thus similar in spirit with alreadyCanceled. - def unsafeApply[F[_]](token: CancelToken[F])(implicit F: Sync[F]): BooleanCancelableF[F]
Unsafe version of apply.
Unsafe version of apply.
This function is unsafe because creating the returned BooleanCancelableF allocates internal shared mutable state, thus breaking referential transparency, which can catch users by surprise.
- Annotations
- @UnsafeBecauseImpure()
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.