Packages

trait ZIOApp extends ZIOAppPlatformSpecific with ZIOAppVersionSpecific

An entry point for a ZIO application that allows sharing layers between applications. For a simpler version that uses the default ZIO environment see ZIOAppDefault.

Self Type
ZIOApp
Linear Supertypes
ZIOAppVersionSpecific, ZIOAppPlatformSpecific, AnyRef, Any
Known Subclasses
Proxy, ZIOAppDefault
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZIOApp
  2. ZIOAppVersionSpecific
  3. ZIOAppPlatformSpecific
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Environment

Abstract Value Members

  1. abstract def layer: ZLayer[ZIOAppArgs with Scope, Any, Environment]

    A layer that manages the acquisition and release of services necessary for the application to run.

  2. abstract def run: ZIO[Environment with ZEnv with ZIOAppArgs with Scope, Any, Any]

    The main function of the application, which can access the command-line arguments through the args helper method of this class.

    The main function of the application, which can access the command-line arguments through the args helper method of this class. If the provided effect fails for any reason, the cause will be logged, and the exit code of the application will be non-zero. Otherwise, the exit code of the application will be zero.

  3. implicit abstract def tag: zio.EnvironmentTag[Environment]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def <>(that: ZIOApp)(implicit trace: ZTraceElement): ZIOApp

    Composes this ZIOApp with another ZIOApp, to yield an application that executes the logic of both applications.

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def exit(code: ExitCode)(implicit trace: ZTraceElement): UIO[Unit]

    A helper function to exit the application with the specified exit code.

  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getArgs(implicit trace: ZTraceElement): ZIO[ZIOAppArgs, Nothing, Chunk[String]]

    A helper function to obtain access to the command-line arguments of the application.

    A helper function to obtain access to the command-line arguments of the application. You may use this helper function inside your run function.

  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hook: RuntimeConfigAspect

    A hook into the ZIO runtime configuration used for boostrapping the application.

    A hook into the ZIO runtime configuration used for boostrapping the application. This hook can be used to install low-level functionality into the ZIO application, such as logging, profiling, and other similar foundational pieces of infrastructure.

  15. def installSignalHandlers(implicit trace: ZTraceElement): UIO[Any]
    Attributes
    protected
  16. final def invoke(args: Chunk[String])(implicit trace: ZTraceElement): ZIO[ZEnv, Any, Any]

    Invokes the main app.

    Invokes the main app. Designed primarily for testing.

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def main(args0: Array[String]): Unit

    The Scala main function, intended to be called only by the Scala runtime.

    The Scala main function, intended to be called only by the Scala runtime.

    Definition Classes
    ZIOAppPlatformSpecific
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def runtime: Runtime[ZEnv]
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. implicit macro def validateEnv[R, E, A](zio: ZIO[R, E, A]): ZIO[Environment with ZEnv with ZIOAppArgs, E, A]

    This implicit conversion macro will ensure that the provided ZIO effect does not require more than the provided environment.

    This implicit conversion macro will ensure that the provided ZIO effect does not require more than the provided environment.

    If it is missing requirements, it will report a descriptive error message. Otherwise, the effect will be returned unmodified.

    Definition Classes
    ZIOAppVersionSpecific
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from ZIOAppVersionSpecific

Inherited from ZIOAppPlatformSpecific

Inherited from AnyRef

Inherited from Any

Ungrouped