Class/Object

monix.execution.misc

Local

Related Docs: object Local | package misc

Permalink

final class Local[A] extends AnyRef

A Local is a ThreadLocal whose scope is flexible. The state of all Locals may be saved or restored onto the current thread by the user. This is useful for threading Locals through execution contexts.

Because it's not meaningful to inherit control from two places, Locals don't have to worry about having to merge two contexts.

Note: the implementation is optimized for situations in which save and restore optimizations are dominant.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Local
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Local(default: ⇒ A)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def :=(value: A): Unit

    Permalink

    Alis for update.

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  5. def apply(): A

    Permalink

    Returns the current value of this Local.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def bind[R](value: A)(f: ⇒ R): R

    Permalink

    Execute a block with a specific local value, restoring the current state upon completion.

  8. def bindClear[R](f: ⇒ R): R

    Permalink

    Execute a block with the Local cleared, restoring the current state upon completion.

  9. def clear(): Unit

    Permalink

    Clear the Local's value.

    Clear the Local's value. Other Locals are not modified.

    General usage should be via bindClear to avoid leaks.

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. def get: A

    Permalink

    Alias for apply.

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  23. def update(value: A): Unit

    Permalink

    Updates the value of this Local.

  24. def value: Option[A]

    Permalink

    Returns the current value of this Local, or None in case this local should fallback to the default.

    Returns the current value of this Local, or None in case this local should fallback to the default.

    Use apply in case automatic fallback is needed.

  25. def value_=(update: Option[A]): Unit

    Permalink

    Updates the current value of this Local.

    Updates the current value of this Local. If the given value is None, then the local gets cleared.

    This operation is a mixture of apply and clear.

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped