Class/Object

zio.Runtime

Scoped

Related Docs: object Scoped | package Runtime

Permalink

abstract class Scoped[+R] extends Runtime[R]

A runtime that can be shutdown to release resources allocated to it.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Scoped
  2. Runtime
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Scoped()

    Permalink

Abstract Value Members

  1. abstract def environment: ZEnvironment[R]

    Permalink

    The environment of the runtime.

    The environment of the runtime.

    Definition Classes
    Runtime
  2. abstract def runtimeConfig: RuntimeConfig

    Permalink

    The configuration of the runtime, which provides the essential capabilities necessary to bootstrap execution of tasks.

    The configuration of the runtime, which provides the essential capabilities necessary to bootstrap execution of tasks.

    Definition Classes
    Runtime
  3. abstract def shutdown(): Unit

    Permalink

    Shuts down this runtime and releases resources allocated to it.

    Shuts down this runtime and releases resources allocated to it. Once this runtime has been shut down the behavior of methods on it is undefined and it should be discarded.

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def as[R1](r1: ZEnvironment[R1]): Scoped[R1]

    Permalink

    Constructs a new Runtime with the specified new environment.

    Constructs a new Runtime with the specified new environment.

    Definition Classes
    ScopedRuntime
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  13. final def map[R1](f: (ZEnvironment[R]) ⇒ ZEnvironment[R1]): Scoped[R1]

    Permalink

    Constructs a new Runtime by mapping the environment.

    Constructs a new Runtime by mapping the environment.

    Definition Classes
    ScopedRuntime
  14. final def mapRuntimeConfig(f: (RuntimeConfig) ⇒ RuntimeConfig): Scoped[R]

    Permalink

    Constructs a new Runtime by mapping the runtime configuration.

    Constructs a new Runtime by mapping the runtime configuration.

    Definition Classes
    ScopedRuntime
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def run[E, A](zio: ZIO[R, E, A])(implicit trace: ZTraceElement): IO[E, A]

    Permalink

    Runs the effect "purely" through an async boundary.

    Runs the effect "purely" through an async boundary. Useful for testing.

    Definition Classes
    Runtime
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def unsafeRun[E, A](zio: ZIO[R, E, A])(implicit trace: ZTraceElement): A

    Permalink

    Executes the effect synchronously, failing with zio.FiberFailure if there are any errors.

    Executes the effect synchronously, failing with zio.FiberFailure if there are any errors. May fail on Scala.js if the effect cannot be entirely run synchronously.

    This method is effectful and should only be done at the edges of your program.

    Definition Classes
    Runtime
  22. final def unsafeRunAsync[E, A](zio: ZIO[R, E, A])(implicit trace: ZTraceElement): Unit

    Permalink

    Executes the effect asynchronously, discarding the result of execution.

    Executes the effect asynchronously, discarding the result of execution.

    This method is effectful and should only be invoked at the edges of your program.

    Definition Classes
    Runtime
  23. final def unsafeRunAsyncCancelable[E, A](zio: ZIO[R, E, A])(k: (Exit[E, A]) ⇒ Any)(implicit trace: ZTraceElement): (FiberId) ⇒ Exit[E, A]

    Permalink

    Executes the effect asynchronously, eventually passing the exit value to the specified callback.

    Executes the effect asynchronously, eventually passing the exit value to the specified callback. It returns a callback, which can be used to interrupt the running execution.

    This method is effectful and should only be invoked at the edges of your program.

    Definition Classes
    Runtime
  24. final def unsafeRunAsyncWith[E, A](zio: ZIO[R, E, A])(k: (Exit[E, A]) ⇒ Any)(implicit trace: ZTraceElement): Unit

    Permalink

    Executes the effect asynchronously, eventually passing the exit value to the specified callback.

    Executes the effect asynchronously, eventually passing the exit value to the specified callback.

    This method is effectful and should only be invoked at the edges of your program.

    Definition Classes
    Runtime
  25. final def unsafeRunSync[E, A](zio0: ZIO[R, E, A])(implicit trace: ZTraceElement): Exit[E, A]

    Permalink

    Executes the effect asynchronously, eventually passing the exit value to the specified callback.

    Executes the effect asynchronously, eventually passing the exit value to the specified callback. It returns a callback, which can be used to interrupt the running execution.

    This method is effectful and should only be invoked at the edges of your program.

    Definition Classes
    Runtime
  26. final def unsafeRunTask[A](task: RIO[R, A])(implicit trace: ZTraceElement): A

    Permalink

    Executes the Task/RIO effect synchronously, failing with the original Throwable on both Cause.Fail and Cause.Die.

    Executes the Task/RIO effect synchronously, failing with the original Throwable on both Cause.Fail and Cause.Die. In addition, appends a new element to the Throwables "caused by" chain, with this Cause "pretty printed" (in stackless mode) as the message. May fail on Scala.js if the effect cannot be entirely run synchronously.

    This method is effectful and should only be done at the edges of your program.

    Definition Classes
    Runtime
  27. final def unsafeRunToFuture[E <: Throwable, A](zio: ZIO[R, E, A])(implicit trace: ZTraceElement): CancelableFuture[A]

    Permalink

    Runs the IO, returning a Future that will be completed when the effect has been executed.

    Runs the IO, returning a Future that will be completed when the effect has been executed.

    This method is effectful and should only be used at the edges of your program.

    Definition Classes
    Runtime
  28. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def withBlockingExecutor(e: Executor): Runtime[R]

    Permalink

    Constructs a new Runtime with the specified blocking executor.

    Constructs a new Runtime with the specified blocking executor.

    Definition Classes
    Runtime
  32. final def withExecutor(e: Executor): Scoped[R]

    Permalink

    Constructs a new Runtime with the specified executor.

    Constructs a new Runtime with the specified executor.

    Definition Classes
    ScopedRuntime
  33. final def withFatal(f: (Throwable) ⇒ Boolean): Scoped[R]

    Permalink

    Constructs a new Runtime with the specified fatal predicate.

    Constructs a new Runtime with the specified fatal predicate.

    Definition Classes
    ScopedRuntime
  34. final def withReportFatal(f: (Throwable) ⇒ Nothing): Scoped[R]

    Permalink

    Constructs a new Runtime with the fatal error reporter.

    Constructs a new Runtime with the fatal error reporter.

    Definition Classes
    ScopedRuntime

Deprecated Value Members

  1. def mapPlatform(f: (Platform) ⇒ Platform): Runtime[R]

    Permalink

    Constructs a new Runtime by mapping the platform.

    Constructs a new Runtime by mapping the platform.

    Definition Classes
    Runtime
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use mapRuntimeConfig

  2. def platform: Platform

    Permalink

    The platform of the runtime, which provides the essential capabilities necessary to bootstrap execution of tasks.

    The platform of the runtime, which provides the essential capabilities necessary to bootstrap execution of tasks.

    Definition Classes
    Runtime
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use runtimeConfig

Inherited from Runtime[R]

Inherited from AnyRef

Inherited from Any

Ungrouped