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.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 Observable pattern:

    monix.tail exposes Iterant for purely functional pull based streaming:

    • monix.tail.batches describes Batch and BatchCursor, the alternatives to Scala's Iterable and Iterator respectively that we are using within Iterant's encoding

    You 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.

    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[A]):

    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
  • object Atomic extends Serializable
    Definition Classes
    atomic
  • Macros

class Macros extends HygieneUtilMacros with InlineMacros

Macros implementations for the Atomic type

Source
Atomic.scala
Linear Supertypes
InlineMacros, HygieneUtilMacros, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Macros
  2. InlineMacros
  3. HygieneUtilMacros
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. def addMacro[A](value: scala.reflect.macros.whitebox.Context.Expr[A])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[A]): scala.reflect.macros.whitebox.Context.Expr[Unit]
  5. def applyMacro[A]()(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[A]): scala.reflect.macros.whitebox.Context.Expr[A]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def buildAnyMacro[A, R <: Atomic[A]](initialValue: scala.reflect.macros.whitebox.Context.Expr[A])(builder: scala.reflect.macros.whitebox.Context.Expr[AtomicBuilder[A, R]])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[A], arg1: scala.reflect.macros.whitebox.Context.WeakTypeTag[R]): scala.reflect.macros.whitebox.Context.Expr[R]
  8. def buildAnyWithPaddingMacro[A, R <: Atomic[A]](initialValue: scala.reflect.macros.whitebox.Context.Expr[A], padding: scala.reflect.macros.whitebox.Context.Expr[PaddingStrategy])(builder: scala.reflect.macros.whitebox.Context.Expr[AtomicBuilder[A, R]])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[A], arg1: scala.reflect.macros.whitebox.Context.WeakTypeTag[R]): scala.reflect.macros.whitebox.Context.Expr[R]
  9. val c: Context
    Definition Classes
    Macros → InlineMacros → HygieneUtilMacros
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. def getAndTransformMacro[A](cb: scala.reflect.macros.whitebox.Context.Expr[(A) => A])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[A]): scala.reflect.macros.whitebox.Context.Expr[A]
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def inlineAndReset[A](tree: scala.reflect.macros.Universe.Tree): scala.reflect.macros.whitebox.Context.Expr[A]
    Definition Classes
    InlineMacros
  18. def inlineAndResetTree(tree: scala.reflect.macros.Universe.Tree): scala.reflect.macros.Universe.Tree
    Definition Classes
    InlineMacros
  19. def inlineApplyRecursive(tree: scala.reflect.macros.Universe.Tree): scala.reflect.macros.Universe.Tree
    Definition Classes
    InlineMacros
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def resetTree(tree: scala.reflect.macros.Universe.Tree): scala.reflect.macros.Universe.Tree
    Definition Classes
    InlineMacros
  25. def setMacro[A](value: scala.reflect.macros.whitebox.Context.Expr[A])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[A]): scala.reflect.macros.whitebox.Context.Expr[Unit]
  26. def stripUnApplyNodes(): scala.reflect.macros.Universe.Transformer

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

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

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

    Definition Classes
    InlineMacros
  27. def subtractMacro[A](value: scala.reflect.macros.whitebox.Context.Expr[A])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[A]): scala.reflect.macros.whitebox.Context.Expr[Unit]
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. def transformAndExtractMacro[S, A](cb: scala.reflect.macros.whitebox.Context.Expr[(S) => (A, S)])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[S], arg1: scala.reflect.macros.whitebox.Context.WeakTypeTag[A]): scala.reflect.macros.whitebox.Context.Expr[A]
  31. def transformAndGetMacro[A](cb: scala.reflect.macros.whitebox.Context.Expr[(A) => A])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[A]): scala.reflect.macros.whitebox.Context.Expr[A]
  32. def transformMacro[A](cb: scala.reflect.macros.whitebox.Context.Expr[(A) => A])(implicit arg0: scala.reflect.macros.whitebox.Context.WeakTypeTag[A]): scala.reflect.macros.whitebox.Context.Expr[Unit]
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. object util
    Definition Classes
    HygieneUtilMacros

Inherited from InlineMacros

Inherited from HygieneUtilMacros

Inherited from AnyRef

Inherited from Any

Ungrouped