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 absolve[R >: LowerR, E <: UpperE, A](v: ZIO[R, E, Either[E, A]]): ZIO[R, E, A]

   Submerges the error case of an Either into the ZIO.

   Submerges the error case of an Either into the ZIO. The inverse operation of IO.either.

5.  final def access[R >: LowerR, A](f: (R) ⇒ A): ZIO[R, Nothing, A]

   Accesses the environment of the effect.

   Accesses the environment of the effect.

   val portNumber = effect.access(_.config.portNumber)

6.  final def accessM[R >: LowerR, E <: UpperE, A](f: (R) ⇒ ZIO[R, E, A]): ZIO[R, E, A]

   Effectfully accesses the environment of the effect.

7.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

8.  final def bracket[R >: LowerR, E <: UpperE, A](acquire: ZIO[R, E, A]): BracketAcquire[R, E, A]

   When this effect represents acquisition of a resource (for example, opening a file, launching a thread, etc.), bracket can be used to ensure the acquisition is not interrupted and the resource is always released.

   When this effect represents acquisition of a resource (for example, opening a file, launching a thread, etc.), bracket can be used to ensure the acquisition is not interrupted and the resource is always released.

   The function does two things:

   1. Ensures this effect, which acquires the resource, will not be interrupted. Of course, acquisition may fail for internal reasons (an uncaught exception). 2. Ensures the release effect will not be interrupted, and will be executed so long as this effect successfully acquires the resource.

   In between acquisition and release of the resource, the use effect is executed.

   If the release effect fails, then the entire effect will fail even if the use effect succeeds. If this fail-fast behavior is not desired, errors produced by the release effect can be caught and ignored.

   openFile("data.json").bracket(closeFile) { file =>
     for {
       header <- readHeader(file)
       ...
     } yield result
   }

9.  final def bracketExit[R >: LowerR, E <: UpperE, A](acquire: ZIO[R, E, A]): BracketExitAcquire[R, E, A]

   Acquires a resource, uses the resource, and then releases the resource.

   Acquires a resource, uses the resource, and then releases the resource. Neither the acquisition nor the release will be interrupted, and the resource is guaranteed to be released, so long as the acquire effect succeeds. If use fails, then after release, the returned effect will fail with the same error.

10.  def clone(): AnyRef

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )

11.  final def collectAll[R >: LowerR, E <: UpperE, A](in: Iterable[ZIO[R, E, A]]): ZIO[R, E, List[A]]

    Evaluate each effect in the structure from left to right, and collect the results.

    Evaluate each effect in the structure from left to right, and collect the results. For a parallel version, see collectAllPar.

12.  final def collectAllPar[R >: LowerR, E <: UpperE, A](as: Iterable[ZIO[R, E, A]]): ZIO[R, E, List[A]]

    Evaluate each effect in the structure in parallel, and collect the results.

    Evaluate each effect in the structure in parallel, and collect the results. For a sequential version, see collectAll.

13.  final def collectAllParN[R >: LowerR, E <: UpperE, A](n: Long)(as: Iterable[ZIO[R, E, A]]): ZIO[R, E, List[A]]

    Evaluate each effect in the structure in parallel, and collect the results.

    Evaluate each effect in the structure in parallel, and collect the results. For a sequential version, see collectAll.

    Unlike foreachAllPar, this method will use at most n fibers.

14.  final def descriptor: UIO[Descriptor]

    Returns information about the current fiber, such as its fiber identity.

15.  final def die(t: Throwable): UIO[Nothing]

    Returns an effect that dies with the specified Throwable.

    Returns an effect that dies with the specified Throwable. This method can be used for terminating a fiber because a defect has been detected in the code.

16.  final def dieMessage(message: String): UIO[Nothing]

    Returns an effect that dies with a java.lang.RuntimeException having the specified text message.

    Returns an effect that dies with a java.lang.RuntimeException having the specified text message. This method can be used for terminating a fiber because a defect has been detected in the code.

17.  final def done[E <: UpperE, A](r: Exit[E, A]): IO[E, A]

    Returns an effect from a scalaz.zio.Exit value.

18.  final def effectAsync[E <: UpperE, A](register: ((ZIO[Any, E, A]) ⇒ Unit) ⇒ Unit): ZIO[Any, E, A]

    Imports an asynchronous effect into a pure ZIO value.

    Imports an asynchronous effect into a pure ZIO value. See effectAsyncMaybe for the more expressive variant of this function that can return a value synchronously.

19.  final def effectAsyncInterrupt[R >: LowerR, E <: UpperE, A](register: ((ZIO[R, E, A]) ⇒ Unit) ⇒ Either[Canceler, ZIO[R, E, A]]): ZIO[R, E, A]

    Imports an asynchronous effect into a pure IO value.

    Imports an asynchronous effect into a pure IO value. The effect has the option of returning the value synchronously, which is useful in cases where it cannot be determined if the effect is synchronous or asynchronous until the effect is actually executed. The effect also has the option of returning a canceler, which will be used by the runtime to cancel the asynchronous effect if the fiber executing the effect is interrupted.

20.  final def effectAsyncM[E <: UpperE, A](register: ((IO[E, A]) ⇒ Unit) ⇒ UIO[_]): IO[E, A]

    Imports an asynchronous effect into a pure ZIO value.

    Imports an asynchronous effect into a pure ZIO value. This formulation is necessary when the effect is itself expressed in terms of ZIO.

21.  final def effectAsyncMaybe[E <: UpperE, A](register: ((ZIO[Any, E, A]) ⇒ Unit) ⇒ Option[IO[E, A]]): ZIO[Any, E, A]

    Imports an asynchronous effect into a pure ZIO value, possibly returning the value synchronously.

22.  final def effectTotal[A](effect: ⇒ A): UIO[A]

    Imports a total synchronous effect into a pure ZIO value.

    Imports a total synchronous effect into a pure ZIO value. The effect must not throw any exceptions. If you wonder if the effect throws exceptions, then do not use this method, use Task.effect, IO.effect, or ZIO.effect.

    val nanoTime: UIO[Long] = IO.effectTotal(System.nanoTime())

23.  final def effectTotalWith[A](effect: (Platform) ⇒ A): UIO[A]

    Imports a total synchronous effect into a pure ZIO value.

    Imports a total synchronous effect into a pure ZIO value. This variant of effectTotal lets the impure code use the platform capabilities.

    The effect must not throw any exceptions. If you wonder if the effect throws exceptions, then do not use this method, use Task.effect, IO.effect, or ZIO.effect.

    val nanoTime: UIO[Long] = IO.effectTotal(System.nanoTime())

24.  final def environment[R >: LowerR]: ZIO[R, Nothing, R]

    Accesses the whole environment of the effect.

25.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

26.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

27.  final def fail[E <: UpperE](error: E): IO[E, Nothing]

    Returns an effect that models failure with the specified error.

    Returns an effect that models failure with the specified error. The moral equivalent of throw for pure code.

28.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

29.  final def flatten[R >: LowerR, E <: UpperE, A](zio: ZIO[R, E, ZIO[R, E, A]]): ZIO[R, E, A]

    Returns an effect that first executes the outer effect, and then executes the inner effect, returning the value from the inner effect, and effectively flattening a nested effect.

30.  final def foldLeft[R >: LowerR, E, S, A](in: Iterable[A])(zero: S)(f: (S, A) ⇒ ZIO[R, E, S]): ZIO[R, E, S]

    Folds an Iterable[A] using an effectful function f, working sequentially.

31.  final def foreach[R >: LowerR, E <: UpperE, A, B](in: Iterable[A])(f: (A) ⇒ ZIO[R, E, B]): ZIO[R, E, List[B]]

    Applies the function f to each element of the Iterable[A] and returns the results in a new List[B].

    Applies the function f to each element of the Iterable[A] and returns the results in a new List[B].

    For a parallel version of this method, see foreachPar.

32.  final def foreachPar[R >: LowerR, E <: UpperE, A, B](as: Iterable[A])(fn: (A) ⇒ ZIO[R, E, B]): ZIO[R, E, List[B]]

    Applies the function f to each element of the Iterable[A] in parallel, and returns the results in a new List[B].

    Applies the function f to each element of the Iterable[A] in parallel, and returns the results in a new List[B].

    For a sequential version of this method, see foreach.

33.  final def foreachParN[R >: LowerR, E <: UpperE, A, B](n: Long)(as: Iterable[A])(fn: (A) ⇒ ZIO[R, E, B]): ZIO[R, E, List[B]]

    Applies the function f to each element of the Iterable[A] in parallel, and returns the results in a new List[B].

    Applies the function f to each element of the Iterable[A] in parallel, and returns the results in a new List[B].

    Unlike foreachPar, this method will use at most up to n fibers.

34.  final def forkAll[R >: LowerR, E <: UpperE, A](as: Iterable[ZIO[R, E, A]]): ZIO[R, Nothing, Fiber[E, List[A]]]

    Returns an effect that forks all of the specified values, and returns a composite fiber that produces a list of their results, in order.

35.  final def forkAll_[R >: LowerR, E <: UpperE, A](as: Iterable[ZIO[R, E, A]]): ZIO[R, Nothing, Unit]

    Returns an effect that forks all of the specified values, and returns a composite fiber that produces unit.

    Returns an effect that forks all of the specified values, and returns a composite fiber that produces unit. This version is faster than forkAll in cases where the results of the forked fibers are not needed.

36.  final def fromEither[E <: UpperE, A](v: ⇒ Either[E, A]): IO[E, A]

    Lifts an Either into a ZIO value.

37.  final def fromFiber[E <: UpperE, A](fiber: ⇒ Fiber[E, A]): IO[E, A]

    Creates a ZIO value that represents the exit value of the specified fiber.

38.  final def fromFiberM[E <: UpperE, A](fiber: IO[E, Fiber[E, A]]): IO[E, A]

    Creates a ZIO value that represents the exit value of the specified fiber.

39.  final def fromFunction[R >: LowerR, A](f: (R) ⇒ A): ZIO[R, Nothing, A]

    Lifts a function R => A into a ZIO[R, Nothing, A].

40.  final def fromFunctionM[R >: LowerR, E, A](f: (R) ⇒ IO[E, A]): ZIO[R, E, A]

    Lifts an effectful function whose effect requires no environment into an effect that requires the input to the function.

41.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

42.  final def halt[E <: UpperE](cause: Cause[E]): IO[E, Nothing]

    Returns an effect that models failure with the specified Cause.

43.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

44.  final val interrupt: UIO[Nothing]

    Returns an effect that is interrupted.

45.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

46.  final def lock[R >: LowerR, E <: UpperE, A](executor: Executor)(zio: ZIO[R, E, A]): ZIO[R, E, A]

    Returns an effect that will execute the specified effect fully on the provided executor, before returning to the default executor.

47.  final def mergeAll[R >: LowerR, E <: UpperE, A, B](in: Iterable[ZIO[R, E, A]])(zero: B)(f: (B, A) ⇒ B): ZIO[R, E, B]

    Merges an Iterable[IO] to a single IO, working in parallel.

48.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

49.  final val never: UIO[Nothing]

    Returns a effect that will never produce anything.

    Returns a effect that will never produce anything. The moral equivalent of while(true) {}, only without the wasted CPU cycles.

50.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

51.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

52.  final def provide[R >: LowerR, E <: UpperE, A](r: R): (ZIO[R, E, A]) ⇒ IO[E, A]

    Given an environment R, returns a function that can supply the environment to programs that require it, removing their need for any specific environment.

    Given an environment R, returns a function that can supply the environment to programs that require it, removing their need for any specific environment.

    This is similar to dependency injection, and the provide function can be thought of as inject.

53.  final def raceAll[R >: LowerR, R1 >: LowerR <: R, E <: UpperE, A](zio: ZIO[R, E, A], ios: Iterable[ZIO[R1, E, A]]): ZIO[R1, E, A]

    Races an IO[E, A] against zero or more other effects.

    Races an IO[E, A] against zero or more other effects. Yields either the first success or the last failure.

54.  final def reduceAll[R >: LowerR, R1 >: LowerR <: R, E <: UpperE, A](a: ZIO[R, E, A], as: Iterable[ZIO[R1, E, A]])(f: (A, A) ⇒ A): ZIO[R1, E, A]

    Reduces an Iterable[IO] to a single IO, working in parallel.

55.  final def require[E <: UpperE, A](error: E): (IO[E, Option[A]]) ⇒ IO[E, A]

    Requires that the given IO[E, Option[A]] contain a value.

    Requires that the given IO[E, Option[A]] contain a value. If there is no value, then the specified error will be raised.

56.  final def runtime[R >: LowerR]: ZIO[R, Nothing, Runtime[R]]

    Returns an effect that accesses the runtime, which can be used to (unsafely) execute tasks.

    Returns an effect that accesses the runtime, which can be used to (unsafely) execute tasks. This is useful for integration with non-functional code that must call back into functional code.

57.  final def succeed[A](a: A): UIO[A]

    Returns an effect that models success with the specified strictly- evaluated value.

58.  final def succeedLazy[A](a: ⇒ A): UIO[A]

    Returns an effect that models success with the specified lazily-evaluated value.

    Returns an effect that models success with the specified lazily-evaluated value. This method should not be used to capture effects. See IO.effectTotal for capturing total effects, and IO.effect for capturing partial effects.

59.  final def supervise[R >: LowerR, E <: UpperE, A](zio: ZIO[R, E, A]): ZIO[R, E, A]

    Returns an effect that supervises the specified effect, ensuring that all fibers that it forks are interrupted as soon as the supervised effect completes.

60.  final def superviseWith[R >: LowerR, E <: UpperE, A](zio: ZIO[R, E, A])(supervisor: (Iterable[Fiber[_, _]]) ⇒ UIO[_]): ZIO[R, E, A]

    Returns an effect that supervises the specified effect, ensuring that all fibers that it forks are passed to the specified supervisor as soon as the supervised effect completes.

61.  final def suspend[R >: LowerR, E <: UpperE, A](io: ⇒ ZIO[R, E, A]): ZIO[R, E, A]

    Returns a lazily constructed effect, whose construction may itself require effects.

    Returns a lazily constructed effect, whose construction may itself require effects. This is a shortcut for flatten(effectTotal(io)).

62.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

63.  def toString(): String

    Definition Classes

    AnyRef → Any

64.  final def unit[R >: LowerR]: ZIO[R, Nothing, Unit]

    Strictly-evaluated unit lifted into the ZIO monad.

65.  final def unsandbox[R >: LowerR, E <: UpperE, A](v: ZIO[R, Cause[E], A]): ZIO[R, E, A]

    The inverse operation IO.sandboxed

    The inverse operation IO.sandboxed

    Terminates with exceptions on the Left side of the Either error, if it exists. Otherwise extracts the contained IO[E, A]

66.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

67.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

68.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )

69.  final def when[R >: LowerR, E <: UpperE](b: Boolean)(zio: ZIO[R, E, _]): ZIO[R, E, Unit]

    The moral equivalent of if (p) exp

70.  final def whenM[R >: LowerR, E <: UpperE](b: ZIO[R, E, Boolean])(zio: ZIO[R, E, _]): ZIO[R, E, Unit]

    The moral equivalent of if (p) exp when p has side-effects

71.  final val yieldNow: UIO[Unit]

    Returns an effect that yields to the runtime system, starting on a fresh stack.

    Returns an effect that yields to the runtime system, starting on a fresh stack. Manual use of this method can improve fairness, at the cost of overhead.