Packages

t

monix.bio

BIOApp

trait BIOApp extends AnyRef

Safe App type that executes a IO. Shutdown occurs after the IO completes, as follows:

- If completed with ExitCode.Success, the main method exits and shutdown is handled by the platform.

- If completed with any other ExitCode, sys.exit is called with the specified code.

- If the IO raises an error, the stack trace is printed to standard error and sys.exit(1) is called.

When a shutdown is requested via a signal, the IO is canceled and we wait for the IO to release any resources. The process exits with the numeric value of the signal plus 128.

import cats.effect._
import cats.implicits._
import monix.bio._

object MyApp extends BIOApp {
  def run(args: List[String]): UIO[ExitCode] =
    args.headOption match {
      case Some(name) =>
        UIO(println(s"Hello, \${name}.")).as(ExitCode.Success)
      case None =>
        UIO(System.err.println("Usage: MyApp name")).as(ExitCode(2))
    }
}

N.B. this is homologous with cats.effect.IOApp, but meant for usage with IO.

Works on top of JavaScript as well ;-)

Source
BIOApp.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BIOApp
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def run(args: List[String]): UIO[ExitCode]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. implicit lazy val catsEffect: ConcurrentEffect[Task]

    Provides the cats.effect.ConcurrentEffect instance of this runtime environment.

    Provides the cats.effect.ConcurrentEffect instance of this runtime environment.

    Attributes
    protected
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def main(args: Array[String]): Unit
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def options: Options

    Options for executing the Task action.

    Options for executing the Task action. The default value is defined in defaultOptions, but can be overridden.

    Attributes
    protected
  18. def scheduler: Scheduler

    Scheduler for executing the Task action.

    Scheduler for executing the Task action. Defaults to global, but can be overridden.

    Attributes
    protected
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped