Class/Object

monix.execution.misc

Local

Related Docs: object Local | package misc

Permalink

final class Local[A] extends LocalDeprecated[A]

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

LocalDeprecated[A], AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Local
LocalDeprecated
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new Local(default: () ⇒ A)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def :=(value: A): Unit

Alis for update.
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def apply(): A

Returns the current value of this Local.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bind[R](value: A)(f: ⇒ R)(implicit R: CanBindLocals[R]): R

Execute a block with a specific local value, restoring the current state upon completion.
Execute a block with a specific local value, restoring the current state upon completion.
The implementation uses the CanBindLocals type class because in case of asynchronous data types that should be waited on, like Future or CompletableFuture, then the locals context also needs to be cleared on the future's completion, for correctness.
def bindClear[R](f: ⇒ R)(implicit R: CanBindLocals[R]): R

Execute a block with the Local cleared, restoring the current state upon completion.
Execute a block with the Local cleared, restoring the current state upon completion.
The implementation uses the CanBindLocals type class because in case of asynchronous data types that should be waited on, like Future or CompletableFuture, then the locals context also needs to be cleared on the future's completion, for correctness.
def clear(): Unit

Clear the Local's value.
Clear the Local's value. Other Locals are not modified.
General usage should be in Local.isolate to avoid leaks.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get: A

Alias for apply.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val key: Key
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def update(value: A): Unit

Updates the value of this Local.
def value: Option[A]

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.
def value_=(update: Option[A]): Unit

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.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from LocalDeprecated[A]

Inherited from AnyRef

Inherited from Any

Ungrouped