Packages

trait Simple extends IOApp

A simplified version of IOApp for applications which ignore their process arguments and always produces ExitCode.Success (unless terminated exceptionally or interrupted).

Source
IOApp.scala
See also

IOApp

Linear Supertypes
IOApp, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Simple
  2. IOApp
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def run: IO[Unit]

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( ... ) @native()
  6. def computeWorkerThreadCount: Int

    Controls the number of worker threads which will be allocated to the compute pool in the underlying runtime.

    Controls the number of worker threads which will be allocated to the compute pool in the underlying runtime. In general, this should be no greater than the number of physical threads made available by the underlying kernel (which can be determined using Runtime.getRuntime().availableProcessors()). For any application which has significant additional non-compute thread utilization (such as asynchronous I/O worker threads), it may be optimal to reduce the number of compute threads by the corresponding amount such that the total number of active threads exactly matches the number of underlying physical threads.

    In practice, tuning this parameter is unlikely to affect your application performance beyond a few percentage points, and the default value is optimal (or close to optimal) in most common scenarios.

    This setting is JVM-specific and will not compile on JavaScript.

    For more details on Cats Effect's runtime threading model please see https://typelevel.org/cats-effect/docs/thread-model.

    Attributes
    protected
    Definition Classes
    IOApp
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): 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[_]
    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
    Definition Classes
    IOApp
  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. final def run(args: List[String]): IO[ExitCode]

    The entry point for your application.

    The entry point for your application. Will be called by the runtime when the process is started. If the underlying runtime supports it, any arguments passed to the process will be made available in the args parameter. The numeric value within the resulting ExitCode will be used as the exit code when the process terminates unless terminated exceptionally or by interrupt.

    args

    The arguments passed to the process, if supported by the underlying runtime. For example, java com.company.MyApp --foo --bar baz or node com-mycompany-fastopt.js --foo --bar baz would each result in List("--foo", "--bar", "baz").

    Definition Classes
    Simple → IOApp
    See also

    IOApp.Simple!.run:cats\.effect\.IO[Unit]*

  18. def runtime: IORuntime

    The runtime which will be used by IOApp to evaluate the IO produced by the run method.

    The runtime which will be used by IOApp to evaluate the IO produced by the run method. This may be overridden by IOApp implementations which have extremely specialized needs, but this is highly unlikely to ever be truly needed. As an example, if an application wishes to make use of an alternative compute thread pool (such as Executors.fixedThreadPool), it is almost always better to leverage IO.evalOn on the value produced by the run method, rather than directly overriding runtime.

    In other words, this method is made available to users, but its use is strongly discouraged in favor of other, more precise solutions to specific use-cases.

    This value is guaranteed to be equal to unsafe.IORuntime.global.

    Attributes
    protected
    Definition Classes
    IOApp
  19. def runtimeConfig: IORuntimeConfig

    The configuration used to initialize the runtime which will evaluate the IO produced by run.

    The configuration used to initialize the runtime which will evaluate the IO produced by run. It is very unlikely that users will need to override this method.

    Attributes
    protected
    Definition Classes
    IOApp
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from IOApp

Inherited from AnyRef

Inherited from Any

Ungrouped