RuntimeFlag

zio.RuntimeFlag
See theRuntimeFlag companion trait
object RuntimeFlag

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case object CooperativeYielding extends RuntimeFlag

The cooperative yielding flag determines whether the ZIO runtime will yield to another fiber while executing long-running effects or continuously forking fibers.

The cooperative yielding flag determines whether the ZIO runtime will yield to another fiber while executing long-running effects or continuously forking fibers.

Disabling this flag is highly discouraged but it is necessary for cases where fine-grained control over fiber scheduling is required.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait RuntimeFlag
class Object
trait Matchable
class Any
Show all
Self type
case object CurrentFiber extends RuntimeFlag

The current fiber flag determines whether or not the ZIO runtime system will store the current fiber inside a ThreadLocal whenever a fiber begins executing on a thread. Use of this flag will negatively impact performance, but is essential where interop with ThreadLocal is required.

The current fiber flag determines whether or not the ZIO runtime system will store the current fiber inside a ThreadLocal whenever a fiber begins executing on a thread. Use of this flag will negatively impact performance, but is essential where interop with ThreadLocal is required.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait RuntimeFlag
class Object
trait Matchable
class Any
Show all
Self type
case object EagerShiftBack extends RuntimeFlag

Determines whether the ZIO runtime will eagerly shift back execution to the default executor following (enabled) or minimize context shifts by continuing execution on the same thread as long as possible (disabled).

Determines whether the ZIO runtime will eagerly shift back execution to the default executor following (enabled) or minimize context shifts by continuing execution on the same thread as long as possible (disabled).

Enabling this flag can positively or negatively affect performance depending on the specific characteristics of the application. For more info on this refer to this blog post.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait RuntimeFlag
class Object
trait Matchable
class Any
Show all
Self type
case object FiberRoots extends RuntimeFlag

The fiber roots flag determines whether or not the ZIO runtime system will keep track of all fiber roots. Use of this flag will negatively impact performance, but is required in order for fiber dumps functionality.

The fiber roots flag determines whether or not the ZIO runtime system will keep track of all fiber roots. Use of this flag will negatively impact performance, but is required in order for fiber dumps functionality.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait RuntimeFlag
class Object
trait Matchable
class Any
Show all
Self type
FiberRoots.type
case object OpLog extends RuntimeFlag

The op log flag determines whether or not the ZIO runtime system will attempt to log all operations of the ZIO runtime. Use of this flag will negatively impact performance and generate massive volumes of ultra-fine debug logs. Only recommended for debugging.

The op log flag determines whether or not the ZIO runtime system will attempt to log all operations of the ZIO runtime. Use of this flag will negatively impact performance and generate massive volumes of ultra-fine debug logs. Only recommended for debugging.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait RuntimeFlag
class Object
trait Matchable
class Any
Show all
Self type
OpLog.type
case object OpSupervision extends RuntimeFlag

The op supervision flag determines whether or not the IO runtime system will supervise all operations of the ZIO runtime. Use of this flag will negatively impact performance, but is required for some operations, such as profiling.

The op supervision flag determines whether or not the IO runtime system will supervise all operations of the ZIO runtime. Use of this flag will negatively impact performance, but is required for some operations, such as profiling.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait RuntimeFlag
class Object
trait Matchable
class Any
Show all
Self type
case object RuntimeMetrics extends RuntimeFlag

The runtime metrics flag determines whether or not the ZIO runtime system will collect metrics about the ZIO runtime. Use of this flag will have a very small negative impact on performance, but generates very helpful operational insight into running ZIO applications that can be exported to Prometheus or other tools via ZIO Metrics.

The runtime metrics flag determines whether or not the ZIO runtime system will collect metrics about the ZIO runtime. Use of this flag will have a very small negative impact on performance, but generates very helpful operational insight into running ZIO applications that can be exported to Prometheus or other tools via ZIO Metrics.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait RuntimeFlag
class Object
trait Matchable
class Any
Show all
Self type

Deprecated classlikes

case object WorkStealing extends RuntimeFlag

The work stealing flag determines whether threads running fibers about to asynchronously suspend will first attempt to steal work before suspending.

The work stealing flag determines whether threads running fibers about to asynchronously suspend will first attempt to steal work before suspending.

'''Note''': this flag is not implemented. zio.internal.ZScheduler will always steal work.

Attributes

Deprecated
[Since version 2.1.19] Unused + unimplemented: using this flag will have no effect
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait RuntimeFlag
class Object
trait Matchable
class Any
Show all
Self type

Inherited and Abstract types

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete fields