Local

Type Members

sealed abstract class Context extends AnyRef

Represents the current state of all locals for a given execution context.
Represents the current state of all locals for a given execution context.
This should be treated as an opaque value and direct modifications and access are considered verboten.
final class Key extends Serializable

Internal — key type used in Context.

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
def apply[A](default: A): Local[A]

Builds a new Local with the given default to be returned if a value hasn't been set, or after the local gets cleared.
Builds a new Local with the given default to be returned if a value hasn't been set, or after the local gets cleared.
```
val num = Local(0)
num() //=> 0

num := 100
num() //=> 100

num.clear()
num() //=> 0
```
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bind[R](ctx: Context)(f: ⇒ R)(implicit R: CanBindLocals[R]): R

Execute a block of code using the specified state of Local.Context and restore the current state when complete.
Execute a block of code using the specified state of Local.Context and restore the current state when complete.
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.
There's no default instance for synchronous actions available in scope. If you need to work with synchronous actions, you need to import it explicitly:
```
import monix.execution.misc.CanBindLocals.Implicits.synchronousAsDefault
```
def bindClear[R](f: ⇒ R)(implicit R: CanBindLocals[R]): R

Execute a block of code with a clear state of Local.Context and restore the current state when complete.
Execute a block of code with a clear state of Local.Context and restore the current state when complete.
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.
There's no default instance for synchronous actions available in scope. If you need to work with synchronous actions, you need to import it explicitly:
```
import monix.execution.misc.CanBindLocals.Implicits.synchronousAsDefault
```
def clearContext(): Unit

Clear the Local state.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def closed[R](fn: () ⇒ R)(implicit R: CanBindLocals[R]): () ⇒ R

Convert a closure () => R into another closure of the same type whose Local.Context is saved when calling closed and restored upon invocation.
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] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getContext(): Context

Return the state of the current Local state.
def hashCode(): Int

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

Definition Classes
Any
def isolate[R](f: ⇒ R)(implicit R: CanBindLocals[R]): R

Execute a block of code without propagating any Local.Context changes outside.
Execute a block of code without propagating any Local.Context changes outside.
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.
There's no default instance for synchronous actions available in scope. If you need to work with synchronous actions, you need to import it explicitly:
```
import monix.execution.misc.CanBindLocals.Implicits.synchronousAsDefault
```
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newContext(): Context

Creates a new, empty Context.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def setContext(ctx: Context): Unit

Restore the Local state to a given Context.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

Deprecated Value Members

def closed[R](fn: () ⇒ R): () ⇒ R

DEPRECATED — switch to local.closed[R: CanIsolate].
DEPRECATED — switch to local.closed[R: CanIsolate].

Definition Classes
LocalCompanionDeprecated
Annotations
@deprecated
Deprecated
(Since version 3.0.0) Switch to local.closed[R: CanIsolate]
def defaultContext(): Unbound

DEPRECATED — switch to Local.newContext.
DEPRECATED — switch to Local.newContext.

Definition Classes
LocalCompanionDeprecated
Annotations
@deprecated
Deprecated
(Since version 3.0.0) Renamed to Local.newContext

Related Docs: class Local | package misc

object Local extends LocalCompanionDeprecated

Type Members

sealed abstract class Context extends AnyRef

final class Key extends Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply[A](default: A): Local[A]

final def asInstanceOf[T0]: T0

def bind[R](ctx: Context)(f: ⇒ R)(implicit R: CanBindLocals[R]): R

def bindClear[R](f: ⇒ R)(implicit R: CanBindLocals[R]): R

def clearContext(): Unit

def clone(): AnyRef

def closed[R](fn: () ⇒ R)(implicit R: CanBindLocals[R]): () ⇒ R

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getContext(): Context

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isolate[R](f: ⇒ R)(implicit R: CanBindLocals[R]): R

final def ne(arg0: AnyRef): Boolean

def newContext(): Context

final def notify(): Unit

final def notifyAll(): Unit

def setContext(ctx: Context): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

def closed[R](fn: () ⇒ R): () ⇒ R

def defaultContext(): Unbound

Inherited from LocalCompanionDeprecated

Inherited from AnyRef

Inherited from Any

Ungrouped