Packages

trait TestConsole extends Console with Restorable

TestConsole provides a testable interface for programs interacting with the console by modeling input and output as reading from and writing to input and output buffers maintained by TestConsole and backed by a Ref.

All calls to print and printLine using the TestConsole will write the string to the output buffer and all calls to readLine will take a string from the input buffer. To facilitate debugging, by default output will also be rendered to standard output. You can enable or disable this for a scope using debug, silent, or the corresponding test aspects.

TestConsole has several methods to access and manipulate the content of these buffers including feedLines to feed strings to the input buffer that will then be returned by calls to readLine, output to get the content of the output buffer from calls to print and printLine, and clearInput and clearOutput to clear the respective buffers.

Together, these functions make it easy to test programs interacting with the console.

import zio.Console._
import zio.test.TestConsole
import zio.ZIO

val sayHello = for {
  name <- readLine
  _    <- printLine("Hello, " + name + "!")
} yield ()

for {
  _ <- TestConsole.feedLines("John", "Jane", "Sally")
  _ <- ZIO.collectAll(List.fill(3)(sayHello))
  result <- TestConsole.output
} yield result == Vector("Hello, John!\n", "Hello, Jane!\n", "Hello, Sally!\n")
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestConsole
  2. Restorable
  3. Console
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def clearInput(implicit trace: ZTraceElement): UIO[Unit]
  2. abstract def clearOutput(implicit trace: ZTraceElement): UIO[Unit]
  3. abstract def debug[R, E, A](zio: ZIO[R, E, A])(implicit trace: ZTraceElement): ZIO[R, E, A]
  4. abstract def feedLines(lines: String*)(implicit trace: ZTraceElement): UIO[Unit]
  5. abstract def output(implicit trace: ZTraceElement): UIO[Vector[String]]
  6. abstract def outputErr(implicit trace: ZTraceElement): UIO[Vector[String]]
  7. abstract def print(line: => Any)(implicit trace: ZTraceElement): IO[IOException, Unit]
    Definition Classes
    Console
  8. abstract def printError(line: => Any)(implicit trace: ZTraceElement): IO[IOException, Unit]
    Definition Classes
    Console
  9. abstract def printLine(line: => Any)(implicit trace: ZTraceElement): IO[IOException, Unit]
    Definition Classes
    Console
  10. abstract def printLineError(line: => Any)(implicit trace: ZTraceElement): IO[IOException, Unit]
    Definition Classes
    Console
  11. abstract def readLine(implicit trace: ZTraceElement): IO[IOException, String]
    Definition Classes
    Console
  12. abstract def save(implicit trace: ZTraceElement): UIO[UIO[Unit]]
    Definition Classes
    Restorable
  13. abstract def silent[R, E, A](zio: ZIO[R, E, A])(implicit trace: ZTraceElement): ZIO[R, E, A]

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 ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def getStrLn(implicit trace: ZTraceElement): IO[IOException, String]
    Definition Classes
    Console
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use readLine

  2. def putStr(line: => String)(implicit trace: ZTraceElement): IO[IOException, Unit]
    Definition Classes
    Console
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use print

  3. def putStrErr(line: => String)(implicit trace: ZTraceElement): IO[IOException, Unit]
    Definition Classes
    Console
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use printError

  4. def putStrLn(line: => String)(implicit trace: ZTraceElement): IO[IOException, Unit]
    Definition Classes
    Console
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use printLine

  5. def putStrLnErr(line: => String)(implicit trace: ZTraceElement): IO[IOException, Unit]
    Definition Classes
    Console
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use printLineError

Inherited from Restorable

Inherited from Console

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped