final case class Options(autoCancelableRunLoops: Boolean, localContextPropagation: Boolean) extends Product with Serializable
Set of options for customizing the task's behavior.
See Task.defaultOptions for the default Options instance
used by Task.runAsync or Task.runToFuture.
- autoCancelableRunLoops
should be set to
truein case you wantflatMapdriven loops to be auto-cancelable. Defaults totrue.- localContextPropagation
should be set to
truein case you want the Local variables to be propagated on async boundaries. Defaults tofalse.
- Source
- Task.scala
- Alphabetic
- By Inheritance
- Options
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Options(autoCancelableRunLoops: Boolean, localContextPropagation: Boolean)
- autoCancelableRunLoops
should be set to
truein case you wantflatMapdriven loops to be auto-cancelable. Defaults totrue.- localContextPropagation
should be set to
truein case you want the Local variables to be propagated on async boundaries. Defaults tofalse.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val autoCancelableRunLoops: Boolean
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def disableAutoCancelableRunLoops: Options
Creates a new set of options from the source, but with the autoCancelableRunLoops value set to
false. - def disableLocalContextPropagation: Options
Creates a new set of options from the source, but with the localContextPropagation value set to
false. - def enableAutoCancelableRunLoops: Options
Creates a new set of options from the source, but with the autoCancelableRunLoops value set to
true. - def enableLocalContextPropagation: Options
Creates a new set of options from the source, but with the localContextPropagation value set to
true. - final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val localContextPropagation: Boolean
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withSchedulerFeatures(implicit s: Scheduler): Options
Enhances the options set with the features of the underlying Scheduler.
Enhances the options set with the features of the underlying Scheduler.
This enables for example the Options.localContextPropagation in case the
Scheduleris a TracingScheduler.
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.