Packages

  • package root

    This is the API documentation for the Monix library.

    Package Overview

    monix.execution exposes lower level primitives for dealing with asynchronous execution:

    monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.

    monix.reactive exposes the Observable pattern:

    monix.types implements type-class shims, to be translated to type-classes provided by libraries such as Cats or Scalaz.

    monix.cats is the optional integration with the Cats library, providing translations for the types described in monix.types.

    monix.scalaz is the optional integration with the Scalaz library, providing translations for the types described in monix.types.

    Definition Classes
    root
  • package monix
    Definition Classes
    root
  • package execution
    Definition Classes
    monix
  • package atomic

    A small toolkit of classes that support compare-and-swap semantics for safe mutation of variables.

    A small toolkit of classes that support compare-and-swap semantics for safe mutation of variables.

    On top of the JVM, this means dealing with lock-free thread-safe programming. Also works on top of Javascript, with Scala.js, for API compatibility purposes and because it's a useful way to box a value.

    The backbone of Atomic references is this method:

    def compareAndSet(expect: T, update: T): Boolean

    This method atomically sets a variable to the update value if it currently holds the expect value, reporting true on success or false on failure. The classes in this package also contain methods to get and unconditionally set values.

    Building a reference is easy with the provided constructor, which will automatically return the most specific type needed (in the following sample, that's an AtomicDouble, inheriting from AtomicNumber[T]):

    val atomicNumber = Atomic(12.2)
    
    atomicNumber.incrementAndGet()
    // => 13.2

    These also provide useful helpers for atomically mutating of values (i.e. transform, transformAndGet, getAndTransform, etc...) or of numbers of any kind (incrementAndGet, getAndAdd, etc...).

    Definition Classes
    execution
  • package cancelables

    Cancelables represent asynchronous units of work or other things scheduled for execution and whose execution can be canceled.

    Cancelables represent asynchronous units of work or other things scheduled for execution and whose execution can be canceled.

    One use-case is the scheduling done by monix.execution.Scheduler, in which the scheduling methods return a Cancelable, allowing the canceling of the scheduling.

    Example:

    val s = ConcurrentScheduler()
    val task = s.scheduleRepeated(10.seconds, 50.seconds, {
      doSomething()
    })
    
    // later, cancels the scheduling ...
    task.cancel()
    Definition Classes
    execution
  • package exceptions
    Definition Classes
    execution
  • package internal
    Definition Classes
    execution
  • package misc
    Definition Classes
    execution
  • package rstreams
    Definition Classes
    execution
  • package schedulers
    Definition Classes
    execution
  • Ack
  • Cancelable
  • CancelableFuture
  • ExecutionModel
  • FutureUtils
  • Listener
  • Macros
  • Scheduler
  • UncaughtExceptionReporter

class Macros extends InlineMacros with HygieneUtilMacros

Various implementations for AckExtensions and Scheduler.

Annotations
@bundle()
Source
Macros.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Macros
  2. HygieneUtilMacros
  3. InlineMacros
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Macros(c: Context)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val c: Context
    Definition Classes
    MacrosHygieneUtilMacrosInlineMacros
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def executeAsync(cb: scala.reflect.macros.Universe.Tree): scala.reflect.macros.Universe.Tree
  10. def executeAsyncBatch(cb: scala.reflect.macros.Universe.Tree): scala.reflect.macros.Universe.Tree
  11. def executeTrampolined(cb: scala.reflect.macros.Universe.Tree): scala.reflect.macros.Universe.Tree
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  15. def inlineAndReset[T](tree: scala.reflect.macros.Universe.Tree): scala.reflect.macros.whitebox.Context.Expr[T]
    Definition Classes
    InlineMacros
  16. def inlineAndResetTree(tree: scala.reflect.macros.Universe.Tree): scala.reflect.macros.Universe.Tree
    Definition Classes
    InlineMacros
  17. def inlineApplyRecursive(tree: scala.reflect.macros.Universe.Tree): scala.reflect.macros.Universe.Tree
    Definition Classes
    InlineMacros
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isSynchronous[Self <: Future[Ack]](implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[Self]): scala.reflect.macros.whitebox.Context.Expr[Boolean]
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  23. def resetTree(tree: scala.reflect.macros.Universe.Tree): scala.reflect.macros.Universe.Tree
    Definition Classes
    InlineMacros
  24. def stripUnApplyNodes(): scala.reflect.macros.Universe.Transformer

    Creates a macro transformer than gets rid of implicit unapply in case statements.

    Creates a macro transformer than gets rid of implicit unapply in case statements.

    Workaround for: https://issues.scala-lang.org/browse/SI-5465

    Definition Classes
    InlineMacros
  25. def syncFlatMap[Self <: Future[Ack]](f: scala.reflect.macros.whitebox.Context.Expr[(Ack) ⇒ Future[Ack]])(s: scala.reflect.macros.whitebox.Context.Expr[Scheduler])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[Self]): scala.reflect.macros.whitebox.Context.Expr[Future[Ack]]
  26. def syncMap[Self <: Future[Ack]](f: scala.reflect.macros.whitebox.Context.Expr[(Ack) ⇒ Ack])(s: scala.reflect.macros.whitebox.Context.Expr[Scheduler])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[Self]): scala.reflect.macros.whitebox.Context.Expr[Future[Ack]]
  27. def syncOnComplete[Self <: Future[Ack]](f: scala.reflect.macros.whitebox.Context.Expr[(Try[Ack]) ⇒ Unit])(s: scala.reflect.macros.whitebox.Context.Expr[Scheduler])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[Self]): scala.reflect.macros.whitebox.Context.Expr[Unit]
  28. def syncOnContinue[Self <: Future[Ack]](callback: scala.reflect.macros.Universe.Tree)(s: scala.reflect.macros.Universe.Tree)(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[Self]): scala.reflect.macros.Universe.Tree
  29. def syncOnStopOrFailure[Self <: Future[Ack]](callback: scala.reflect.macros.Universe.Tree)(s: scala.reflect.macros.Universe.Tree)(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[Self]): scala.reflect.macros.Universe.Tree
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. object util
    Definition Classes
    HygieneUtilMacros

Inherited from HygieneUtilMacros

Inherited from InlineMacros

Inherited from AnyRef

Inherited from Any

Ungrouped