Trait/Object

zio

ZIOApp

Related Docs: object ZIOApp | package zio

Permalink

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
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

    Permalink

Abstract Value Members

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

    Permalink

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

  2. implicit abstract def environmentTag: zio.EnvironmentTag[Environment]

    Permalink
  3. abstract def run: ZIO[Environment with ZIOAppArgs with Scope, Any, Any]

    Permalink

    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.

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 <>(that: ZIOApp)(implicit trace: Trace): ZIOApp

    Permalink

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

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  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. final def exit(code: ExitCode)(implicit trace: Trace): UIO[Unit]

    Permalink

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

  10. def finalize(): Unit

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

    Permalink

    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[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. def installSignalHandlers(runtime: Runtime[Any])(implicit trace: Trace): UIO[Any]

    Permalink
    Attributes
    protected
  15. final def invoke(args: Chunk[String])(implicit trace: Trace): ZIO[Any, Any, Any]

    Permalink

    Invokes the main app.

    Invokes the main app. Designed primarily for testing.

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. final def main(args0: Array[String]): Unit

    Permalink

    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
  18. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  21. def runtime: Runtime[Any]

    Permalink
  22. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  24. implicit macro def validateEnv[R1, R, E, A](zio: ZIO[R, E, A]): ZIO[R1, E, A]

    Permalink

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ZIOAppVersionSpecific

Inherited from ZIOAppPlatformSpecific

Inherited from AnyRef

Inherited from Any

Ungrouped