Trait/Object

zio

ZIOAppDefault

Related Docs: object ZIOAppDefault | package zio

Permalink

trait ZIOAppDefault extends ZIOApp

The entry point for a ZIO application.

import zio.ZIOAppDefault
import zio.Console._

object MyApp extends ZIOAppDefault {

  def run =
    for {
      _ <- printLine("Hello! What is your name?")
      n <- readLine
      _ <- printLine("Hello, " + n + ", good to meet you!")
    } yield ()
}
Linear Supertypes
ZIOApp, ZIOAppVersionSpecific, ZIOAppPlatformSpecific, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZIOAppDefault
  2. ZIOApp
  3. ZIOAppVersionSpecific
  4. ZIOAppPlatformSpecific
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Environment = Clock with Console with System with Random

    Permalink
    Definition Classes
    ZIOAppDefault → ZIOApp

Abstract Value Members

  1. abstract def run: ZIO[Environment with ZEnv with ZIOAppArgs, 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.

    Definition Classes
    ZIOApp

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: ZTraceElement): ZIOApp

    Permalink

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

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

    Definition Classes
    ZIOApp

  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: ZTraceElement): UIO[Unit]

    Permalink

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

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

    Definition Classes
    ZIOApp

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getArgs(implicit trace: ZTraceElement): 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.

    Definition Classes
    ZIOApp

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  14. def hook: RuntimeConfigAspect

    Permalink

    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.

    Definition Classes
    ZIOApp

  15. def installSignalHandlers(implicit trace: ZTraceElement): UIO[Any]

    Permalink
    Attributes
    protected
    Definition Classes
    ZIOApp

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

    Permalink

    Invokes the main app.

    Invokes the main app. Designed primarily for testing.

    Definition Classes
    ZIOApp

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. val layer: ZLayer[ZIOAppArgs, Any, ZEnv]

    Permalink

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

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

    Definition Classes
    ZIOAppDefault → ZIOApp

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

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. def runtime: Runtime[ZEnv]

    Permalink
    Definition Classes
    ZIOApp

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

    Permalink
    Definition Classes
    AnyRef

  25. val tag: zio.EnvironmentTag[ZEnv]

    Permalink
    Definition Classes
    ZIOAppDefault → ZIOApp

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  27. implicit macro def validateEnv[R, E, A](zio: ZIO[R, E, A]): ZIO[Environment with ZEnv with ZIOAppArgs, 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

  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( ... )

Inherited from ZIOApp

Inherited from ZIOAppVersionSpecific

Inherited from ZIOAppPlatformSpecific

Inherited from AnyRef

Inherited from Any

Ungrouped