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
use
d 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
- Alphabetic
- By Inheritance
- ResourceApp
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def main(args: Array[String]): Unit
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()