Packages

trait ResourceApp extends AnyRef

A convenience trait for defining applications which are entirely within Resource. This is implemented as a relatively straightforward wrapper around IOApp and thus inherits most of its functionality and semantics.

This trait should generally be used for any application which would otherwise trivially end with cats.effect.kernel.Resource!.use (or one of its variants). For example:

object HttpExample extends IOApp {
  def run(args: List[String]) = {
    val program = for {
      config <- Resource.eval(loadConfig(args.head))
      postgres <- Postgres[IO](config.jdbcUri)
      endpoints <- ExampleEndpoints[IO](config, postgres)
      _ <- HttpServer[IO](config.host, config.port, endpoints)
    } yield ()

    program.useForever.as(ExitCode.Success)
  }
}

This example assumes some underlying libraries like Skunk and Http4s, but otherwise it represents a relatively typical example of what the main class for a realistic Cats Effect application might look like. Notably, the whole thing is enclosed in Resource, which is used at the very end. This kind of pattern is so common that ResourceApp defines a special trait which represents it. We can rewrite the above example:

object HttpExample extends ResourceApp.Forever {
  def run(args: List[String]) =
    for {
      config <- Resource.eval(loadConfig(args.head))
      db <- Postgres[IO](config.jdbcUri)
      endpoints <- ExampleEndpoints[IO](config, db)
      _ <- HttpServer[IO](config.host, config.port, endpoints)
    } yield ()
}

These two programs are equivalent.

Self Type
ResourceApp
Source
ResourceApp.scala
See also

run

ResourceApp.Simple

ResourceApp.Forever

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResourceApp
  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]): Resource[IO, ExitCode]

    See also

    IOApp.run

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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def main(args: Array[String]): Unit
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped