Packages

object IO extends IOCompanionPlatform with IOLowPriorityImplicits

Source
IO.scala
Linear Supertypes
IOLowPriorityImplicits, IOCompanionPlatform, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IO
  2. IOLowPriorityImplicits
  3. IOCompanionPlatform
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class IOMonoid[A] extends IOSemigroup[A] with Monoid[IO[A]]
    Attributes
    protected
  2. class IOSemigroup[A] extends Semigroup[IO[A]]
    Attributes
    protected
    Definition Classes
    IOLowPriorityImplicits
  3. class IOSemigroupK extends SemigroupK[IO]
    Attributes
    protected
  4. type Par[A] = T[IO, A]

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. def apply[A](thunk: ⇒ A): IO[A]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def async[A](k: ((Either[Throwable, A]) ⇒ Unit) ⇒ IO[Option[IO[Unit]]]): IO[A]
  7. implicit def asyncForIO: kernel.Async[IO]
  8. def async_[A](k: ((Either[Throwable, A]) ⇒ Unit) ⇒ Unit): IO[A]
  9. def blocking[A](thunk: ⇒ A): IO[A]
    Definition Classes
    IOCompanionPlatform
  10. def both[A, B](left: IO[A], right: IO[B]): IO[(A, B)]
  11. def bothOutcome[A, B](left: IO[A], right: IO[B]): IO[(OutcomeIO[A], OutcomeIO[B])]
  12. def bracketFull[A, B](acquire: (Poll[IO]) ⇒ IO[A])(use: (A) ⇒ IO[B])(release: (A, OutcomeIO[B]) ⇒ IO[Unit]): IO[B]
  13. def canceled: IO[Unit]
  14. def cede: IO[Unit]
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  16. implicit val consoleForIO: Console[IO]
  17. def cont[K, R](body: Cont[IO, K, R]): IO[R]

    This is a low-level API which is meant for implementors, please use background, start, async, or Deferred instead, depending on the use case

  18. def defer[A](thunk: ⇒ IO[A]): IO[A]
  19. def deferred[A]: IO[Deferred[IO, A]]
  20. def delay[A](thunk: ⇒ A): IO[A]
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def eval[A](fa: Eval[A]): IO[A]
  24. def executionContext: IO[ExecutionContext]
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def fromCompletableFuture[A](fut: IO[CompletableFuture[A]]): IO[A]
    Definition Classes
    IOCompanionPlatform
  27. def fromEither[A](e: Either[Throwable, A]): IO[A]
  28. def fromFuture[A](fut: IO[Future[A]]): IO[A]
  29. def fromOption[A](o: Option[A])(orElse: ⇒ Throwable): IO[A]
  30. def fromTry[A](t: Try[A]): IO[A]
  31. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  32. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  33. def interruptible[A](many: Boolean)(thunk: ⇒ A): IO[A]
    Definition Classes
    IOCompanionPlatform
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. implicit def monoidForIO[A](implicit arg0: Monoid[A]): Monoid[IO[A]]
  36. def monotonic: IO[FiniteDuration]
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def never[A]: IO[A]
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. def parSequenceN[T[_], A](n: Int)(tma: T[IO[A]])(implicit arg0: Traverse[T]): IO[T[A]]

    Like Parallel.parSequence, but limits the degree of parallelism.

  42. def parTraverseN[T[_], A, B](n: Int)(ta: T[A])(f: (A) ⇒ IO[B])(implicit arg0: Traverse[T]): IO[T[B]]

    Like Parallel.parTraverse, but limits the degree of parallelism.

  43. implicit def parallelForIO: Aux[IO, Par]
  44. def print[A](a: A)(implicit S: Show[A] = Show.fromToString[A]): IO[Unit]

    Prints a value to the standard output using the implicit cats.Show instance.

    Prints a value to the standard output using the implicit cats.Show instance.

    a

    value to be printed to the standard output

    See also

    cats.effect.std.Console for more standard input, output and error operations

  45. def println[A](a: A)(implicit S: Show[A] = Show.fromToString[A]): IO[Unit]

    Prints a value to the standard output followed by a new line using the implicit cats.Show instance.

    Prints a value to the standard output followed by a new line using the implicit cats.Show instance.

    a

    value to be printed to the standard output

    See also

    cats.effect.std.Console for more standard input, output and error operations

  46. def pure[A](value: A): IO[A]
  47. def race[A, B](left: IO[A], right: IO[B]): IO[Either[A, B]]
  48. def racePair[A, B](left: IO[A], right: IO[B]): IO[Either[(OutcomeIO[A], FiberIO[B]), (FiberIO[A], OutcomeIO[B])]]
  49. def raiseError[A](t: Throwable): IO[A]
  50. def raiseUnless(cond: Boolean)(e: ⇒ Throwable): IO[Unit]

    Returns raiseError when cond is false, otherwise IO.unit

    Returns raiseError when cond is false, otherwise IO.unit

    Example:
    1. val tooMany = 5
      val x: Int = ???
      IO.raiseUnless(x < tooMany)(new IllegalArgumentException("Too many"))
  51. def raiseWhen(cond: Boolean)(e: ⇒ Throwable): IO[Unit]

    Returns raiseError when the cond is true, otherwise IO.unit

    Returns raiseError when the cond is true, otherwise IO.unit

    Example:
    1. val tooMany = 5
      val x: Int = ???
      IO.raiseWhen(x >= tooMany)(new IllegalArgumentException("Too many"))
  52. def readLine: IO[String]

    Reads a line as a string from the standard input using the platform's default charset, as per java.nio.charset.Charset.defaultCharset().

    Reads a line as a string from the standard input using the platform's default charset, as per java.nio.charset.Charset.defaultCharset().

    The effect can raise a java.io.EOFException if no input has been consumed before the EOF is observed. This should never happen with the standard input, unless it has been replaced with a finite java.io.InputStream through java.lang.System#setIn or similar.

    returns

    an IO effect that describes reading the user's input from the standard input as a string

    See also

    cats.effect.std.Console#readLineWithCharset for reading using a custom java.nio.charset.Charset

  53. def realTime: IO[FiniteDuration]
  54. def realTimeInstant: IO[Instant]
    Definition Classes
    IOCompanionPlatform
  55. def ref[A](a: A): IO[Ref[IO, A]]
  56. implicit def semigroupForIO[A](implicit arg0: Semigroup[A]): Semigroup[IO[A]]
    Definition Classes
    IOLowPriorityImplicits
  57. implicit val semigroupKForIO: SemigroupK[IO]
  58. implicit def showForIO[A](implicit arg0: Show[A]): Show[IO[A]]
  59. implicit def showForIONoPure[A]: Show[IO[A]]
    Definition Classes
    IOLowPriorityImplicits
  60. def sleep(delay: FiniteDuration): IO[Unit]
  61. def stub: IO[Nothing]
  62. def suspend[A](hint: Type)(thunk: ⇒ A): IO[A]
    Definition Classes
    IOCompanionPlatform
  63. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  64. def toString(): String
    Definition Classes
    AnyRef → Any
  65. def uncancelable[A](body: (Poll[IO]) ⇒ IO[A]): IO[A]
  66. def unit: IO[Unit]
  67. def unlessA(cond: Boolean)(action: ⇒ IO[Unit]): IO[Unit]

    Returns the given argument if cond is false, otherwise IO.Unit

    Returns the given argument if cond is false, otherwise IO.Unit

    See also

    IO.whenA for the inverse

    IO.raiseWhen for conditionally raising an error

  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  71. def whenA(cond: Boolean)(action: ⇒ IO[Unit]): IO[Unit]

    Returns the given argument if cond is true, otherwise IO.Unit

    Returns the given argument if cond is true, otherwise IO.Unit

    See also

    IO.unlessA for the inverse

    IO.raiseWhen for conditionally raising an error

Inherited from IOLowPriorityImplicits

Inherited from IOCompanionPlatform

Inherited from AnyRef

Inherited from Any

Ungrouped