ZIO

Companion object ZIO

sealed trait ZIO[-R, +E, +A] extends Product with Serializable with ZIOPlatformSpecific[R, E, A] with ZIOVersionSpecific[R, E, A]

A ZIO[R, E, A] value is an immutable value (called an "effect") that describes an async, concurrent workflow. In order to be executed, the workflow requires a value of type ZEnvironment[R], and when executed, the workflow will either produce a failure of type E, or a success of type A.

ZIO effects may informally be thought of as functions of the following form:

ZEnvironment[R] => Either[E, A]

ZIO effects model resourceful interaction with the outside world, including synchronous, asynchronous, concurrent, and parallel interaction.

The async and concurrent operations of ZIO effects are powered by fibers, which are lightweight, green threads that enable high scalability.

To run an effect, you need a Runtime, which is capable of executing effects. Runtimes bundle a thread pool together with the environment that effects need.

Self Type: ZIO[R, E, A]

Linear Supertypes

ZIOVersionSpecific[R, E, A], ZIOPlatformSpecific[R, E, A], Serializable, Product, Equals, AnyRef, Any

Known Subclasses

Exit, Failure, Success

Ordering

Alphabetic
By Inheritance

Inherited

ZIO
ZIOVersionSpecific
ZIOPlatformSpecific
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def canEqual(that: Any): Boolean
Definition Classes
Equals
abstract def productArity: Int
Definition Classes
Product
abstract def productElement(n: Int): Any
Definition Classes
Product

Concrete Value Members

final def !(implicit ev1: <:<[E, Throwable], ev2: CanFail[E], trace: Trace): ZIO[R, Nothing, A]
A symbolic alias for orDie.
final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def &>[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, B]
Returns an effect that executes both this effect and the specified effect, in parallel, returning result of provided effect.
Returns an effect that executes both this effect and the specified effect, in parallel, returning result of provided effect. If either side fails, then the other side will be interrupted.
final def *>[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, B]
A variant of flatMap that ignores the value produced by this effect.
final def <&[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, A]
Returns an effect that executes both this effect and the specified effect, in parallel, this effect result returned.
Returns an effect that executes both this effect and the specified effect, in parallel, this effect result returned. If either side fails, then the other side will be interrupted.
final def <&>[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit zippable: Zippable[A, B], trace: Trace): ZIO[R1, E1, Out]
Returns an effect that executes both this effect and the specified effect, in parallel, combining their results into a tuple.
Returns an effect that executes both this effect and the specified effect, in parallel, combining their results into a tuple. If either side fails, then the other side will be interrupted.
final def <*[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, A]
Sequences the specified effect after this effect, but ignores the value produced by the effect.
final def <*>[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit zippable: Zippable[A, B], trace: Trace): ZIO[R1, E1, Out]
Sequentially zips this effect with the specified effect, combining the results into a tuple.
final def <+>[R1 <: R, E1, B](that: => ZIO[R1, E1, B])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E1, Either[A, B]]
A symbolic alias for orElseEither.
final def <>[R1 <: R, E2, A1 >: A](that: => ZIO[R1, E2, A1])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E2, A1]
Operator alias for orElse.
final def <|>[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, Either[A, B]]
A symbolic alias for raceEither.
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def @@[LowerR <: UpperR, UpperR <: R, LowerE >: E, UpperE >: LowerE, LowerA >: A, UpperA >: LowerA](aspect: => ZIOAspect[LowerR, UpperR, LowerE, UpperE, LowerA, UpperA])(implicit trace: Trace): ZIO[UpperR, LowerE, LowerA]
Returns a new effect that applies the specified aspect to this effect.
Returns a new effect that applies the specified aspect to this effect. Aspects are "transformers" that modify the behavior of their input in some well-defined way (for example, adding a timeout).
final def absolve[E1 >: E, B](implicit ev: IsSubtypeOfOutput[A, Either[E1, B]], trace: Trace): ZIO[R, E1, B]
Returns an effect that submerges the error case of an Either into the ZIO.
Returns an effect that submerges the error case of an Either into the ZIO. The inverse operation of ZIO.either.
final def absorb(implicit ev: IsSubtypeOfError[E, Throwable], trace: Trace): RIO[R, A]
Attempts to convert defects into a failure, throwing away all information about the cause of the failure.
final def absorbWith(f: (E) => Throwable)(implicit trace: Trace): RIO[R, A]
Attempts to convert defects into a failure, throwing away all information about the cause of the failure.
final def as[B](b: => B)(implicit trace: Trace): ZIO[R, E, B]
Maps the success value of this effect to the specified constant value.
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def asLeft(implicit trace: Trace): ZIO[R, E, Either[A, Nothing]]
Maps the success value of this effect to a left value.
final def asLeftError(implicit trace: Trace): ZIO[R, Either[E, Nothing], A]
Maps the error value of this effect to a left value.
final def asRight(implicit trace: Trace): ZIO[R, E, Either[Nothing, A]]
Maps the success value of this effect to a right value.
final def asRightError(implicit trace: Trace): ZIO[R, Either[Nothing, E], A]
Maps the error value of this effect to a right value.
final def asSome(implicit trace: Trace): ZIO[R, E, Option[A]]
Maps the success value of this effect to an optional value.
final def asSomeError(implicit trace: Trace): ZIO[R, Option[E], A]
Maps the error value of this effect to an optional value.
final def awaitAllChildren(implicit trace: Trace): ZIO[R, E, A]
Returns a new effect that will not succeed with its value before first waiting for the end of all child fibers forked by the effect.
final def cached(timeToLive: => zio.Duration)(implicit trace: Trace): ZIO[R, Nothing, IO[E, A]]
Returns an effect that, if evaluated, will return the cached result of this effect.
Returns an effect that, if evaluated, will return the cached result of this effect. Cached results will expire after timeToLive duration.
final def cachedInvalidate(timeToLive0: => zio.Duration)(implicit trace: Trace): ZIO[R, Nothing, (IO[E, A], UIO[Unit])]
Returns an effect that, if evaluated, will return the cached result of this effect.
Returns an effect that, if evaluated, will return the cached result of this effect. Cached results will expire after timeToLive duration. In addition, returns an effect that can be used to invalidate the current cached value before the timeToLive duration expires.
final def catchAll[R1 <: R, E2, A1 >: A](h: (E) => ZIO[R1, E2, A1])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E2, A1]
Recovers from all errors.
Recovers from all errors.
```
openFile("config.json").catchAll(_ => ZIO.succeed(defaultConfig))
```
final def catchAllCause[R1 <: R, E2, A1 >: A](k: (Cause[E]) => ZIO[R1, E2, A1])(implicit trace: Trace): ZIO[R1, E2, A1]
Recovers from all errors with provided Cause.
Recovers from all errors with provided Cause.
```
openFile("config.json").catchAllCause(_ => ZIO.succeed(defaultConfig))
```
See also
absorb, sandbox, mapErrorCause - other functions that can recover from defects
final def catchAllDefect[R1 <: R, E1 >: E, A1 >: A](h: (Throwable) => ZIO[R1, E1, A1])(implicit trace: Trace): ZIO[R1, E1, A1]
Recovers from all defects with provided function.
Recovers from all defects with provided function.
```
effect.catchSomeDefect(_ => backup())
```
WARNING: There is no sensible way to recover from defects. This method should be used only at the boundary between ZIO and an external system, to transmit information on a defect for diagnostic or explanatory purposes.
final def catchAllTrace[R1 <: R, E2, A1 >: A](h: ((E, StackTrace)) => ZIO[R1, E2, A1])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E2, A1]
A version of catchAll that gives you the (optional) trace of the error.
final def catchNonFatalOrDie[R1 <: R, E2, A1 >: A](h: (E) => ZIO[R1, E2, A1])(implicit ev1: CanFail[E], ev2: <:<[E, Throwable], trace: Trace): ZIO[R1, E2, A1]
Recovers from all NonFatal Throwables.
Recovers from all NonFatal Throwables.
```
openFile("data.json").catchNonFatalOrDie(_ => openFile("backup.json"))
```
final def catchSome[R1 <: R, E1 >: E, A1 >: A](pf: PartialFunction[E, ZIO[R1, E1, A1]])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E1, A1]
Recovers from some or all of the error cases.
Recovers from some or all of the error cases.
```
openFile("data.json").catchSome {
  case _: FileNotFoundException => openFile("backup.json")
}
```
final def catchSomeCause[R1 <: R, E1 >: E, A1 >: A](pf: PartialFunction[Cause[E], ZIO[R1, E1, A1]])(implicit trace: Trace): ZIO[R1, E1, A1]
Recovers from some or all of the error cases with provided cause.
Recovers from some or all of the error cases with provided cause.
```
openFile("data.json").catchSomeCause {
  case c if (c.interrupted) => openFile("backup.json")
}
```
final def catchSomeDefect[R1 <: R, E1 >: E, A1 >: A](pf: PartialFunction[Throwable, ZIO[R1, E1, A1]])(implicit trace: Trace): ZIO[R1, E1, A1]
Recovers from some or all of the defects with provided partial function.
Recovers from some or all of the defects with provided partial function.
```
effect.catchSomeDefect {
  case _: SecurityException => backup()
}
```
WARNING: There is no sensible way to recover from defects. This method should be used only at the boundary between ZIO and an external system, to transmit information on a defect for diagnostic or explanatory purposes.
final def catchSomeTrace[R1 <: R, E1 >: E, A1 >: A](pf: PartialFunction[(E, StackTrace), ZIO[R1, E1, A1]])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E1, A1]
A version of catchSome that gives you the trace of the error.
final def cause(implicit trace: Trace): URIO[R, Cause[E]]
Returns an effect that succeeds with the cause of failure of this effect, or Cause.empty if the effect did succeed.
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def collect[E1 >: E, B](e: => E1)(pf: PartialFunction[A, B])(implicit trace: Trace): ZIO[R, E1, B]
Fail with e if the supplied PartialFunction does not match, otherwise succeed with the returned value.
final def collectZIO[R1 <: R, E1 >: E, B](e: => E1)(pf: PartialFunction[A, ZIO[R1, E1, B]])(implicit trace: Trace): ZIO[R1, E1, B]
Fail with e if the supplied PartialFunction does not match, otherwise continue with the returned value.
final def daemonChildren(implicit trace: Trace): ZIO[R, E, A]
Returns a new effect that will not supervise any fibers forked by this effect.
final def debug(prefix: => String)(implicit trace: Trace): ZIO[R, E, A]
Taps the effect, printing the result of calling .toString on the value.
Taps the effect, printing the result of calling .toString on the value. Prefixes the output with the given message.
final def debug(implicit trace: Trace): ZIO[R, E, A]
Taps the effect, printing the result of calling .toString on the value.
final def delay(duration: => zio.Duration)(implicit trace: Trace): ZIO[R, E, A]
Returns an effect that is delayed from this effect by the specified zio.Duration.
def diffFiberRefs(implicit trace: Trace): ZIO[R, E, (Patch, A)]
Returns a new workflow that executes this one and captures the changes in FiberRef values.
final def disconnect(implicit trace: Trace): ZIO[R, E, A]
Returns an effect that is always interruptible, but whose interruption will be performed in the background.
Returns an effect that is always interruptible, but whose interruption will be performed in the background.
This method is useful to create "fast interrupting" effects. For example, if you call this on an acquire release effect, then even if the effect is "stuck" in acquire or release, its interruption will return immediately, while the acquire / release are performed in the background.
See timeout and race for other applications.
final def either(implicit ev: CanFail[E], trace: Trace): URIO[R, Either[E, A]]
Returns an effect whose failure and success have been lifted into an Either.
Returns an effect whose failure and success have been lifted into an Either. The resulting effect cannot fail, because the failure case has been exposed as part of the Either success case.
This method is useful for recovering from ZIO effects that may fail.
The error parameter of the returned ZIO is Nothing, since it is guaranteed the ZIO effect does not model failure.
final def ensuring[R1 <: R](finalizer: => URIO[R1, Any])(implicit trace: Trace): ZIO[R1, E, A]
Returns an effect that, if this effect _starts_ execution, then the specified finalizer is guaranteed to begin execution, whether this effect succeeds, fails, or is interrupted.
Returns an effect that, if this effect _starts_ execution, then the specified finalizer is guaranteed to begin execution, whether this effect succeeds, fails, or is interrupted.
For use cases that need access to the effect's result, see ZIO#onExit.
Finalizers offer very powerful guarantees, but they are low-level, and should generally not be used for releasing resources. For higher-level logic built on ensuring, see ZIO#acquireReleaseWith.
final def ensuringChild[R1 <: R](f: (Fiber[Any, Iterable[Any]]) => ZIO[R1, Nothing, Any])(implicit trace: Trace): ZIO[R1, E, A]
Acts on the children of this fiber (collected into a single fiber), guaranteeing the specified callback will be invoked, whether or not this effect succeeds.
def ensuringChildren[R1 <: R](children: (Chunk[Fiber.Runtime[Any, Any]]) => ZIO[R1, Nothing, Any])(implicit trace: Trace): ZIO[R1, E, A]
Acts on the children of this fiber, guaranteeing the specified callback will be invoked, whether or not this effect succeeds.
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def eventually(implicit ev: CanFail[E], trace: Trace): URIO[R, A]
Returns an effect that ignores errors and runs repeatedly until it eventually succeeds.
final def exit(implicit trace: Trace): URIO[R, Exit[E, A]]
Returns an effect that semantically runs the effect on a fiber, producing an zio.Exit for the completion value of the fiber.
final def exitCode(implicit trace: Trace): URIO[R, ExitCode]
Maps this effect to the default exit codes.
final def exitWith[R1 <: R, E1, B](f: (Exit[E, A]) => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, B]
Extracts this effect as an zio.Exit and then applies the provided function to produce a new effect
final def filterOrDie(p: (A) => Boolean)(t: => Throwable)(implicit trace: Trace): ZIO[R, E, A]
Dies with specified Throwable if the predicate fails.
final def filterOrDieMessage(p: (A) => Boolean)(message: => String)(implicit trace: Trace): ZIO[R, E, A]
Dies with a java.lang.RuntimeException having the specified text message if the predicate fails.
final def filterOrDieWith(p: (A) => Boolean)(t: (A) => Throwable)(implicit trace: Trace): ZIO[R, E, A]
Dies with t if the predicate fails.
final def filterOrElse[R1 <: R, E1 >: E, A1 >: A](p: (A) => Boolean)(zio: => ZIO[R1, E1, A1])(implicit trace: Trace): ZIO[R1, E1, A1]
Supplies zio if the predicate fails.
final def filterOrElseWith[R1 <: R, E1 >: E, A1 >: A](p: (A) => Boolean)(f: (A) => ZIO[R1, E1, A1])(implicit trace: Trace): ZIO[R1, E1, A1]
Applies f if the predicate fails.
final def filterOrFail[E1 >: E](p: (A) => Boolean)(e: => E1)(implicit trace: Trace): ZIO[R, E1, A]
Fails with e if the predicate fails.
final def firstSuccessOf[R1 <: R, E1 >: E, A1 >: A](rest: => Iterable[ZIO[R1, E1, A1]])(implicit trace: Trace): ZIO[R1, E1, A1]
Returns an effect that runs this effect and in case of failure, runs each of the specified effects in order until one of them succeeds.
def flatMap[R1 <: R, E1 >: E, B](k: (A) => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, B]
Returns an effect that models the execution of this effect, followed by the passing of its value to the specified continuation function k, followed by the effect that it returns.
Returns an effect that models the execution of this effect, followed by the passing of its value to the specified continuation function k, followed by the effect that it returns.
```
val parsed = readFile("foo.txt").flatMap(file => parseFile(file))
```
final def flatMapError[R1 <: R, E2](f: (E) => URIO[R1, E2])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E2, A]
Creates a composite effect that represents this effect followed by another one that may depend on the error produced by this one.
Creates a composite effect that represents this effect followed by another one that may depend on the error produced by this one.
```
val parsed = readFile("foo.txt").flatMapError(error => logErrorToFile(error))
```
final def flatten[R1 <: R, E1 >: E, B](implicit ev1: IsSubtypeOfOutput[A, ZIO[R1, E1, B]], trace: Trace): ZIO[R1, E1, B]
Returns an effect that performs the outer effect first, followed by the inner effect, yielding the value of the inner effect.
Returns an effect that performs the outer effect first, followed by the inner effect, yielding the value of the inner effect.
This method can be used to "flatten" nested effects.
final def flattenErrorOption[E1, E2 <: E1](default: => E2)(implicit ev: IsSubtypeOfError[E, Option[E1]], trace: Trace): ZIO[R, E1, A]
Unwraps the optional error, defaulting to the provided value.
final def flip(implicit trace: Trace): ZIO[R, A, E]
Returns an effect that swaps the error/success cases.
Returns an effect that swaps the error/success cases. This allows you to use all methods on the error channel, possibly before flipping back.
final def flipWith[R1, A1, E1](f: (ZIO[R, A, E]) => ZIO[R1, A1, E1])(implicit trace: Trace): ZIO[R1, E1, A1]
Swaps the error/value parameters, applies the function f and flips the parameters back
final def fold[B](failure: (E) => B, success: (A) => B)(implicit ev: CanFail[E], trace: Trace): URIO[R, B]
Folds over the failure value or the success value to yield an effect that does not fail, but succeeds with the value returned by the left or right function passed to fold.
final def foldCause[B](failure: (Cause[E]) => B, success: (A) => B)(implicit trace: Trace): URIO[R, B]
A more powerful version of fold that allows recovering from any kind of failure except external interruption.
def foldCauseZIO[R1 <: R, E2, B](failure: (Cause[E]) => ZIO[R1, E2, B], success: (A) => ZIO[R1, E2, B])(implicit trace: Trace): ZIO[R1, E2, B]
A more powerful version of foldZIO that allows recovering from any kind of failure except external interruption.
final def foldTraceZIO[R1 <: R, E2, B](failure: ((E, StackTrace)) => ZIO[R1, E2, B], success: (A) => ZIO[R1, E2, B])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E2, B]
A version of foldZIO that gives you the trace of the error.
final def foldZIO[R1 <: R, E2, B](failure: (E) => ZIO[R1, E2, B], success: (A) => ZIO[R1, E2, B])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E2, B]
Recovers from errors by accepting one effect to execute for the case of an error, and one effect to execute for the case of success.
Recovers from errors by accepting one effect to execute for the case of an error, and one effect to execute for the case of success.
This method has better performance than either since no intermediate value is allocated and does not require subsequent calls to flatMap to define the next effect.
The error parameter of the returned IO may be chosen arbitrarily, since it will depend on the IOs returned by the given continuations.
final def forEachZIO[R1 <: R, E2, B](f: (A) => ZIO[R1, E2, B])(implicit trace: Trace): ZIO[R1, E2, Option[B]]
Returns a new effect that will pass the success value of this effect to the provided callback.
Returns a new effect that will pass the success value of this effect to the provided callback. If this effect fails, then the failure will be ignored.
final def forever(implicit trace: Trace): ZIO[R, E, Nothing]
final def fork(implicit trace: Trace): URIO[R, Fiber.Runtime[E, A]]
Returns an effect that forks this effect into its own separate fiber, returning the fiber immediately, without waiting for it to begin executing the effect.
Returns an effect that forks this effect into its own separate fiber, returning the fiber immediately, without waiting for it to begin executing the effect.
You can use the fork method whenever you want to execute an effect in a new fiber, concurrently and without "blocking" the fiber executing other effects. Using fibers can be tricky, so instead of using this method directly, consider other higher-level methods, such as raceWith, zipPar, and so forth.
The fiber returned by this method has methods to interrupt the fiber and to wait for it to finish executing the effect. See zio.Fiber for more information.
Whenever you use this method to launch a new fiber, the new fiber is attached to the parent fiber's scope. This means when the parent fiber terminates, the child fiber will be terminated as well, ensuring that no fibers leak. This behavior is called "auto supervision", and if this behavior is not desired, you may use the forkDaemon or forkIn methods.
```
for {
  fiber <- subtask.fork
  // Do stuff...
  a <- fiber.join
} yield a
```
final def forkDaemon(implicit trace: Trace): URIO[R, Fiber.Runtime[E, A]]
Forks the effect into a new fiber attached to the global scope.
Forks the effect into a new fiber attached to the global scope. Because the new fiber is attached to the global scope, when the fiber executing the returned effect terminates, the forked fiber will continue running.
final def forkIn(scope: => Scope)(implicit trace: Trace): URIO[R, Fiber.Runtime[E, A]]
Forks the effect in the specified scope.
Forks the effect in the specified scope. The fiber will be interrupted when the scope is closed.
final def forkScoped(implicit trace: Trace): ZIO[R with Scope, Nothing, Fiber.Runtime[E, A]]
Forks the fiber in a Scope, interrupting it when the scope is closed.
final def forkWithErrorHandler[R1 <: R](handler: (E) => URIO[R1, Any])(implicit trace: Trace): URIO[R1, Fiber.Runtime[E, A]]
Like fork but handles an error with the provided handler.
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def head[B](implicit ev: IsSubtypeOfOutput[A, List[B]], trace: Trace): ZIO[R, Option[E], B]
Returns a successful effect with the head of the list if the list is non-empty or fails with the error None if the list is empty.
final def ignore(implicit trace: Trace): URIO[R, Unit]
Returns a new effect that ignores the success or failure of this effect.
final def ignoreLogged(implicit trace: Trace): URIO[R, Unit]
Returns a new effect that ignores the success or failure of this effect, but which also logs failures at the Debug level, just in case the failure turns out to be important.
final def interruptAllChildren(implicit trace: Trace): ZIO[R, E, A]
Returns a new effect that will not succeed with its value before first interrupting all child fibers forked by the effect.
final def interruptStatus(flag: => InterruptStatus)(implicit trace: Trace): ZIO[R, E, A]
Switches the interrupt status for this effect.
Switches the interrupt status for this effect. If true is used, then the effect becomes interruptible (the default), while if false is used, then the effect becomes uninterruptible. These changes are compositional, so they only affect regions of the effect.
final def interruptible(implicit trace: Trace): ZIO[R, E, A]
Returns a new effect that performs the same operations as this effect, but interruptibly, even if composed inside of an uninterruptible region.
Returns a new effect that performs the same operations as this effect, but interruptibly, even if composed inside of an uninterruptible region.
Note that effects are interruptible by default, so this function only has meaning if used within an uninterruptible region.
WARNING: This operator "punches holes" into effects, allowing them to be interrupted in unexpected places. Do not use this operator unless you know exactly what you are doing. Instead, you should use ZIO.uninterruptibleMask.
final def intoPromise[E1 >: E, A1 >: A](p: => Promise[E1, A1])(implicit trace: Trace): URIO[R, Boolean]
Returns an effect that keeps or breaks a promise based on the result of this effect.
Returns an effect that keeps or breaks a promise based on the result of this effect. Synchronizes interruption, so if this effect is interrupted, the specified promise will be interrupted, too.
final def isFailure(implicit trace: Trace): URIO[R, Boolean]
Returns whether this effect is a failure.
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def isSuccess(implicit trace: Trace): URIO[R, Boolean]
Returns whether this effect is a success.
final def left[B, C](implicit ev: IsSubtypeOfOutput[A, Either[B, C]], trace: Trace): ZIO[R, Either[E, C], B]
"Zooms in" on the value in the Left side of an Either, moving the possibility that the value is a Right to the error channel.
final def leftWith[R1, E1, A1, B, B1, C, C1](f: (ZIO[R, Either[E, C], B]) => ZIO[R1, Either[E1, C1], B1])(implicit ev: IsSubtypeOfOutput[A, Either[B, C]], trace: Trace): ZIO[R1, E1, Either[B1, C1]]
Performs the specified operation while "zoomed in" on the Left case of an Either.
final def logError(message: => String)(implicit trace: Trace): ZIO[R, E, A]
Logs the cause of failure of this workflow with the specified message.
final def logError(implicit trace: Trace): ZIO[R, E, A]
Logs the cause of failure of this workflow.
def logSpan(label: => String)(implicit trace: Trace): ZIO[R, E, A]
Adjusts the label for the current logging span.
Adjusts the label for the current logging span.
```
parseRequest(req).logSpan("parsing")
```
final def map[B](f: (A) => B)(implicit trace: Trace): ZIO[R, E, B]
Returns an effect whose success is mapped by the specified f function.
final def mapAttempt[B](f: (A) => B)(implicit ev: IsSubtypeOfError[E, Throwable], trace: Trace): RIO[R, B]
Returns an effect whose success is mapped by the specified side effecting f function, translating any thrown exceptions into typed failed effects.
final def mapBoth[E2, B](f: (E) => E2, g: (A) => B)(implicit ev: CanFail[E], trace: Trace): ZIO[R, E2, B]
Returns an effect whose failure and success channels have been mapped by the specified pair of functions, f and g.
final def mapError[E2](f: (E) => E2)(implicit ev: CanFail[E], trace: Trace): ZIO[R, E2, A]
Returns an effect with its error channel mapped using the specified function.
Returns an effect with its error channel mapped using the specified function. This can be used to lift a "smaller" error into a "larger" error.
final def mapErrorCause[E2](h: (Cause[E]) => Cause[E2])(implicit trace: Trace): ZIO[R, E2, A]
Returns an effect with its full cause of failure mapped using the specified function.
Returns an effect with its full cause of failure mapped using the specified function. This can be used to transform errors while preserving the original structure of Cause.
See also
absorb, sandbox, catchAllCause - other functions for dealing with defects
final def memoize(implicit trace: Trace): UIO[ZIO[R, E, A]]
Returns an effect that, if evaluated, will return the lazily computed result of this effect.
final def merge[A1 >: A](implicit ev1: IsSubtypeOfError[E, A1], ev2: CanFail[E], trace: Trace): URIO[R, A1]
Returns a new effect where the error channel has been merged into the success channel to their common combined type.
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def negate(implicit ev: IsSubtypeOfOutput[A, Boolean], trace: Trace): ZIO[R, E, Boolean]
Returns a new effect where boolean value of this effect is negated.
final def none[B](implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZIO[R, Option[E], Unit]
Requires the option produced by this value to be None.
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def onDone[R1 <: R](error: (E) => ZIO[R1, Nothing, Any], success: (A) => ZIO[R1, Nothing, Any])(implicit trace: Trace): ZIO[R1, Nothing, Unit]
Executes the specified success or error callback depending on the result of this effect, synchronously completing the effect before returning.
final def onDoneCause[R1 <: R](error: (Cause[E]) => ZIO[R1, Nothing, Any], success: (A) => ZIO[R1, Nothing, Any])(implicit trace: Trace): ZIO[R1, Nothing, Unit]
Executes the specified success or cause-based error callback depending on the result of this effect, synchronously completing the effect before returning.
final def onError[R1 <: R](cleanup: (Cause[E]) => URIO[R1, Any])(implicit trace: Trace): ZIO[R1, E, A]
Runs the specified effect if this effect fails, providing the error to the effect if it exists.
Runs the specified effect if this effect fails, providing the error to the effect if it exists. The provided effect will not be interrupted.
final def onExecutionContext(ec: => ExecutionContext)(implicit trace: Trace): ZIO[R, E, A]
Executes the effect on the specified ExecutionContext and then shifts back to the default one.
final def onExecutor(executor: => Executor)(implicit trace: Trace): ZIO[R, E, A]
Returns an effect which is guaranteed to be executed on the specified executor.
Returns an effect which is guaranteed to be executed on the specified executor. The specified effect will always run on the specified executor, even in the presence of asynchronous boundaries.
This is useful when an effect must be executed somewhere, for example: on a UI thread, inside a client library's thread pool, inside a blocking thread pool, inside a low-latency thread pool, or elsewhere.
The onExecutor function composes with the innermost onExecutor taking priority. Use of this method does not alter the execution semantics of other effects composed with this one, making it easy to compositionally reason about where effects are running.
final def onExit[R1 <: R](cleanup: (Exit[E, A]) => URIO[R1, Any])(implicit trace: Trace): ZIO[R1, E, A]
Ensures that a cleanup functions runs, whether this effect succeeds, fails, or is interrupted.
final def onInterrupt[R1 <: R](cleanup: (Set[FiberId]) => URIO[R1, Any])(implicit trace: Trace): ZIO[R1, E, A]
Calls the specified function, and runs the effect it returns, if this effect is interrupted.
final def onInterrupt[R1 <: R](cleanup: => URIO[R1, Any])(implicit trace: Trace): ZIO[R1, E, A]
Runs the specified effect if this effect is interrupted.
final def onTermination[R1 <: R](cleanup: (Cause[Nothing]) => URIO[R1, Any])(implicit trace: Trace): ZIO[R1, E, A]
Runs the specified effect if this effect is terminated, either because of a defect or because of interruption.
final def once(implicit trace: Trace): UIO[ZIO[R, E, Unit]]
Returns an effect that will be executed at most once, even if it is evaluated multiple times.
final def option(implicit ev: CanFail[E], trace: Trace): URIO[R, Option[A]]
Executes this effect, skipping the error but returning optionally the success.
final def orDie(implicit ev1: IsSubtypeOfError[E, Throwable], ev2: CanFail[E], trace: Trace): URIO[R, A]
Translates effect failure into death of the fiber, making all failures unchecked and not a part of the type of the effect.
final def orDieWith(f: (E) => Throwable)(implicit ev: CanFail[E], trace: Trace): URIO[R, A]
Keeps none of the errors, and terminates the fiber with them, using the specified function to convert the E into a Throwable.
final def orElse[R1 <: R, E2, A1 >: A](that: => ZIO[R1, E2, A1])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E2, A1]
Executes this effect and returns its value, if it succeeds, but otherwise executes the specified effect.
final def orElseEither[R1 <: R, E2, B](that: => ZIO[R1, E2, B])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E2, Either[A, B]]
Returns an effect that will produce the value of this effect, unless it fails, in which case, it will produce the value of the specified effect.
def orElseFail[E1](e1: => E1)(implicit ev: CanFail[E], trace: Trace): ZIO[R, E1, A]
Executes this effect and returns its value, if it succeeds, but otherwise fails with the specified error.
final def orElseOptional[R1 <: R, E1, A1 >: A](that: => ZIO[R1, Option[E1], A1])(implicit ev: IsSubtypeOfError[E, Option[E1]], trace: Trace): ZIO[R1, Option[E1], A1]
Returns an effect that will produce the value of this effect, unless it fails with the None value, in which case it will produce the value of the specified effect.
final def orElseSucceed[A1 >: A](a1: => A1)(implicit ev: CanFail[E], trace: Trace): URIO[R, A1]
Executes this effect and returns its value, if it succeeds, but otherwise succeeds with the specified value.
final def parallelErrors[E1 >: E](implicit trace: Trace): ZIO[R, ::[E1], A]
Exposes all parallel errors in a single call
final def parallelFinalizers(implicit trace: Trace): ZIO[R, E, A]
Returns a new scoped workflow that runs finalizers added to the scope of this workflow in parallel.
def productElementName(n: Int): String
Definition Classes
Product
def productElementNames: Iterator[String]
Definition Classes
Product
def productIterator: Iterator[Any]
Definition Classes
Product
def productPrefix: String
Definition Classes
Product
macro def provide[E1 >: E](layer: ZLayer[_, E1, _]*): ZIO[Any, E1, A]
Automatically assembles a layer for the ZIO effect.
Automatically assembles a layer for the ZIO effect.
Definition Classes
ZIOVersionSpecific
final def provideEnvironment(r: => ZEnvironment[R])(implicit trace: Trace): IO[E, A]
Provides the ZIO effect with its required environment, which eliminates its dependency on R.
final def provideLayer[E1 >: E, R0](layer: => ZLayer[R0, E1, R])(implicit trace: Trace): ZIO[R0, E1, A]
Provides a layer to the ZIO effect, which translates it to another level.
def provideSome[R0]: ProvideSomeLayerPartiallyApplied[R0, R, E, A]
Splits the environment into two parts, assembling one part using the specified layer and leaving the remainder R0.
Splits the environment into two parts, assembling one part using the specified layer and leaving the remainder R0.
```
val clockLayer: ZLayer[Any, Nothing, Clock] = ???

val zio: ZIO[Clock with Random, Nothing, Unit] = ???

val zio2 = zio.provideSome[Random](clockLayer)
```
Definition Classes
ZIOVersionSpecific
final def provideSomeEnvironment[R0](f: (ZEnvironment[R0]) => ZEnvironment[R])(implicit trace: Trace): ZIO[R0, E, A]
Transforms the environment being provided to this effect with the specified function.
final def provideSomeLayer[R0]: ProvideSomeLayer[R0, R, E, A]
Splits the environment into two parts, providing one part using the specified layer and leaving the remainder R0.
Splits the environment into two parts, providing one part using the specified layer and leaving the remainder R0.
```
val zio: ZIO[Logging with Database, Nothing, Unit] = ???

val loggingLayer: ZLayer[Any, Nothing, Logging] = ???

val zio2 = zio.provideSomeLayer[Database](loggingLayer)
```
final def race[R1 <: R, E1 >: E, A1 >: A](that: => ZIO[R1, E1, A1])(implicit trace: Trace): ZIO[R1, E1, A1]
Returns an effect that races this effect with the specified effect, returning the first successful A from the faster side.
Returns an effect that races this effect with the specified effect, returning the first successful A from the faster side. If one effect succeeds, the other will be interrupted. If neither succeeds, then the effect will fail with some error.
WARNING: The raced effect will safely interrupt the "loser", but will not resume until the loser has been cleanly terminated. If early return is desired, then instead of performing l race r, perform l.disconnect race r.disconnect, which disconnects left and right interrupt signal, allowing a fast return, with interruption performed in the background.
final def raceAll[R1 <: R, E1 >: E, A1 >: A](ios0: => Iterable[ZIO[R1, E1, A1]])(implicit trace: Trace): ZIO[R1, E1, A1]
Returns an effect that races this effect with all the specified effects, yielding the value of the first effect to succeed with a value.
Returns an effect that races this effect with all the specified effects, yielding the value of the first effect to succeed with a value. Losers of the race will be interrupted immediately
final def raceEither[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, Either[A, B]]
Returns an effect that races this effect with the specified effect, yielding the first result to succeed.
Returns an effect that races this effect with the specified effect, yielding the first result to succeed. If neither effect succeeds, then the composed effect will fail with some error.
WARNING: The raced effect will safely interrupt the "loser", but will not resume until the loser has been cleanly terminated. If early return is desired, then instead of performing l raceEither r, perform l.disconnect raceEither r.disconnect, which disconnects left and right interrupt signal, allowing the earliest possible return.
final def raceFirst[R1 <: R, E1 >: E, A1 >: A](that: => ZIO[R1, E1, A1])(implicit trace: Trace): ZIO[R1, E1, A1]
Returns an effect that races this effect with the specified effect, yielding the first result to complete, whether by success or failure.
Returns an effect that races this effect with the specified effect, yielding the first result to complete, whether by success or failure. If neither effect completes, then the composed effect will not complete.
WARNING: The raced effect will safely interrupt the "loser", but will not resume until the loser has been cleanly terminated. If early return is desired, then instead of performing l raceFirst r, perform l.disconnect raceFirst r.disconnect, which disconnects left and right interrupt signal, allowing a fast return, with interruption performed in the background.
final def raceWith[R1 <: R, E1, E2, B, C](that: => ZIO[R1, E1, B])(leftDone: (Exit[E, A], Fiber[E1, B]) => ZIO[R1, E2, C], rightDone: (Exit[E1, B], Fiber[E, A]) => ZIO[R1, E2, C])(implicit trace: Trace): ZIO[R1, E2, C]
Returns an effect that races this effect with the specified effect, calling the specified finisher as soon as one result or the other has been computed.
final def refineOrDie[E1](pf: PartialFunction[E, E1])(implicit ev1: IsSubtypeOfError[E, Throwable], ev2: CanFail[E], trace: Trace): ZIO[R, E1, A]
Keeps some of the errors, and terminates the fiber with the rest
final def refineOrDieWith[E1](pf: PartialFunction[E, E1])(f: (E) => Throwable)(implicit ev: CanFail[E], trace: Trace): ZIO[R, E1, A]
Keeps some of the errors, and terminates the fiber with the rest, using the specified function to convert the E into a Throwable.
final def reject[E1 >: E](pf: PartialFunction[A, E1])(implicit trace: Trace): ZIO[R, E1, A]
Fail with the returned value if the PartialFunction matches, otherwise continue with our held value.
final def rejectZIO[R1 <: R, E1 >: E](pf: PartialFunction[A, ZIO[R1, E1, E1]])(implicit trace: Trace): ZIO[R1, E1, A]
Continue with the returned computation if the PartialFunction matches, translating the successful match into a failure, otherwise continue with our held value.
final def repeat[R1 <: R, B](schedule: => Schedule[R1, A, B])(implicit trace: Trace): ZIO[R1, E, B]
Returns a new effect that repeats this effect according to the specified schedule or until the first failure.
Returns a new effect that repeats this effect according to the specified schedule or until the first failure. Scheduled recurrences are in addition to the first execution, so that io.repeat(Schedule.once) yields an effect that executes io, and then if that succeeds, executes io an additional time.
final def repeatN(n: => Int)(implicit trace: Trace): ZIO[R, E, A]
Returns a new effect that repeats this effect the specified number of times or until the first failure.
Returns a new effect that repeats this effect the specified number of times or until the first failure. Repeats are in addition to the first execution, so that io.repeatN(1) yields an effect that executes io, and then if that succeeds, executes io an additional time.
final def repeatOrElse[R1 <: R, E2, B](schedule: => Schedule[R1, A, B], orElse: (E, Option[B]) => ZIO[R1, E2, B])(implicit trace: Trace): ZIO[R1, E2, B]
Returns a new effect that repeats this effect according to the specified schedule or until the first failure, at which point, the failure value and schedule output are passed to the specified handler.
Returns a new effect that repeats this effect according to the specified schedule or until the first failure, at which point, the failure value and schedule output are passed to the specified handler.
Scheduled recurrences are in addition to the first execution, so that io.repeat(Schedule.once) yields an effect that executes io, and then if that succeeds, executes io an additional time.
final def repeatOrElseEither[R1 <: R, B, E2, C](schedule0: => Schedule[R1, A, B], orElse: (E, Option[B]) => ZIO[R1, E2, C])(implicit trace: Trace): ZIO[R1, E2, Either[C, B]]
Returns a new effect that repeats this effect according to the specified schedule or until the first failure, at which point, the failure value and schedule output are passed to the specified handler.
Returns a new effect that repeats this effect according to the specified schedule or until the first failure, at which point, the failure value and schedule output are passed to the specified handler.
Scheduled recurrences are in addition to the first execution, so that io.repeat(Schedule.once) yields an effect that executes io, and then if that succeeds, executes io an additional time.
final def repeatUntil(p: (A) => Boolean)(implicit trace: Trace): ZIO[R, E, A]
Repeats this effect until its value satisfies the specified predicate or until the first failure.
final def repeatUntilEquals[A1 >: A](a: => A1)(implicit trace: Trace): ZIO[R, E, A1]
Repeats this effect until its value is equal to the specified value or until the first failure.
final def repeatUntilZIO[R1 <: R](f: (A) => URIO[R1, Boolean])(implicit trace: Trace): ZIO[R1, E, A]
Repeats this effect until its value satisfies the specified effectful predicate or until the first failure.
final def repeatWhile(p: (A) => Boolean)(implicit trace: Trace): ZIO[R, E, A]
Repeats this effect while its value satisfies the specified predicate or until the first failure.
final def repeatWhileEquals[A1 >: A](a: => A1)(implicit trace: Trace): ZIO[R, E, A1]
Repeats this effect for as long as its value is equal to the specified value or until the first failure.
final def repeatWhileZIO[R1 <: R](f: (A) => URIO[R1, Boolean])(implicit trace: Trace): ZIO[R1, E, A]
Repeats this effect while its value satisfies the specified effectful predicate or until the first failure.
final def replicateZIO(n: => Int)(implicit trace: Trace): ZIO[R, E, Iterable[A]]
Performs this effect the specified number of times and collects the results.
final def replicateZIODiscard(n: => Int)(implicit trace: Trace): ZIO[R, E, Unit]
Performs this effect the specified number of times, discarding the results.
final def resurrect(implicit ev1: IsSubtypeOfError[E, Throwable], trace: Trace): RIO[R, A]
Unearth the unchecked failure of the effect.
Unearth the unchecked failure of the effect. (opposite of orDie)
```
val f0: Task[Unit] = ZIO.fail(new Exception("failing")).unit
val f1: UIO[Unit]  = f0.orDie
val f2: Task[Unit] = f1.resurrect
```
final def retry[R1 <: R, S](policy: => Schedule[R1, E, S])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E, A]
Retries with the specified retry policy.
Retries with the specified retry policy. Retries are done following the failure of the original io (up to a fixed maximum with once or recurs for example), so that that io.retry(Schedule.once) means "execute io and in case of failure, try again once".
final def retryN(n: => Int)(implicit ev: CanFail[E], trace: Trace): ZIO[R, E, A]
Retries this effect the specified number of times.
final def retryOrElse[R1 <: R, A1 >: A, S, E1](policy: => Schedule[R1, E, S], orElse: (E, S) => ZIO[R1, E1, A1])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E1, A1]
Retries with the specified schedule, until it fails, and then both the value produced by the schedule together with the last error are passed to the recovery function.
final def retryOrElseEither[R1 <: R, Out, E1, B](schedule0: => Schedule[R1, E, Out], orElse: (E, Out) => ZIO[R1, E1, B])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E1, Either[B, A]]
Returns an effect that retries this effect with the specified schedule when it fails, until the schedule is done, then both the value produced by the schedule together with the last error are passed to the specified recovery function.
final def retryUntil(f: (E) => Boolean)(implicit ev: CanFail[E], trace: Trace): ZIO[R, E, A]
Retries this effect until its error satisfies the specified predicate.
final def retryUntilEquals[E1 >: E](e: => E1)(implicit ev: CanFail[E1], trace: Trace): ZIO[R, E1, A]
Retries this effect until its error is equal to the specified error.
final def retryUntilZIO[R1 <: R](f: (E) => URIO[R1, Boolean])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E, A]
Retries this effect until its error satisfies the specified effectful predicate.
final def retryWhile(f: (E) => Boolean)(implicit ev: CanFail[E], trace: Trace): ZIO[R, E, A]
Retries this effect while its error satisfies the specified predicate.
final def retryWhileEquals[E1 >: E](e: => E1)(implicit ev: CanFail[E1], trace: Trace): ZIO[R, E1, A]
Retries this effect for as long as its error is equal to the specified error.
final def retryWhileZIO[R1 <: R](f: (E) => URIO[R1, Boolean])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E, A]
Retries this effect while its error satisfies the specified effectful predicate.
final def right[B, C](implicit ev: IsSubtypeOfOutput[A, Either[B, C]], trace: Trace): ZIO[R, Either[B, E], C]
"Zooms in" on the value in the Right side of an Either, moving the possibility that the value is a Left to the error channel.
final def rightWith[R1, E1, A1, B, B1, C, C1](f: (ZIO[R, Either[B, E], C]) => ZIO[R1, Either[B1, E1], C1])(implicit ev: IsSubtypeOfOutput[A, Either[B, C]], trace: Trace): ZIO[R1, E1, Either[B1, C1]]
Performs the specified operation while "zoomed in" on the Right case of an Either.

final def sandbox(implicit trace: Trace): ZIO[R, Cause[E], A]

Exposes the full cause of failure of this effect.

final case class DomainError()

val veryBadIO: IO[DomainError, Unit] =
  ZIO.succeed(5 / 0) *> ZIO.fail(DomainError())

val caught: IO[DomainError, Unit] =
  veryBadIO.sandbox.mapError(_.untraced).catchAll {
    case Cause.Die(_: ArithmeticException) =>
      // Caught defect: divided by zero!
      ZIO.unit
    case Cause.Fail(_) =>
      // Caught error: DomainError!
      ZIO.unit
    case cause =>
      // Caught unknown defects, shouldn't recover!
      ZIO.refailCause(cause)
  }

final def sandboxWith[R1 <: R, E2, B](f: (ZIO[R1, Cause[E], A]) => ZIO[R1, Cause[E2], B])(implicit trace: Trace): ZIO[R1, E2, B]
Companion helper to sandbox.
Companion helper to sandbox. Allows recovery, and partial recovery, from errors and defects alike, as in:
```
case class DomainError()

val veryBadIO: IO[DomainError, Unit] =
  ZIO.succeed(5 / 0) *> ZIO.fail(DomainError())

val caught: IO[DomainError, Unit] =
  veryBadIO.sandboxWith[Any, DomainError, Unit](_.catchSome {
    case Cause.Die(_: ArithmeticException, _)=>
      // Caught defect: divided by zero!
      ZIO.succeed(0)
  })
```
Using sandboxWith with catchSome is better than using io.sandbox.catchAll with a partial match, because in the latter, if the match fails, the original defects will be lost and replaced by a MatchError
final def schedule[R1 <: R, B](schedule: => Schedule[R1, Any, B])(implicit trace: Trace): ZIO[R1, E, B]
Runs this effect according to the specified schedule.
Runs this effect according to the specified schedule.
See scheduleFrom for a variant that allows the schedule's decision to depend on the result of this effect.
final def scheduleFork[R1 <: R, B](schedule: => Schedule[R1, Any, B])(implicit trace: Trace): ZIO[R1 with Scope, Nothing, Fiber.Runtime[E, B]]
Runs this effect according to the specified schedule in a new fiber attached to the current scope.
final def scheduleFrom[R1 <: R, A1 >: A, B](a: => A1)(schedule0: => Schedule[R1, A1, B])(implicit trace: Trace): ZIO[R1, E, B]
Runs this effect according to the specified schedule starting from the specified input value.
final def sequentialFinalizers(implicit trace: Trace): ZIO[R, E, A]
Returns a new scoped workflow that runs finalizers added to the scope of this workflow sequentially in the reverse of the order in which they were added.
Returns a new scoped workflow that runs finalizers added to the scope of this workflow sequentially in the reverse of the order in which they were added. Note that finalizers are run sequentially by default so this only has meaning if used within a scope where finalizers are being run in parallel.
final def some[B](implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZIO[R, Option[E], B]
Converts an option on values into an option on errors.
final def someOrElse[B, C](default: => C)(implicit ev0: IsSubtypeOfOutput[A, Option[B]], ev1: <:<[C, B], trace: Trace): ZIO[R, E, B]
Extracts the optional value, or returns the given 'default'.
final def someOrElse[B](default: => B)(implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZIO[R, E, B]
Extracts the optional value, or returns the given 'default'.
Extracts the optional value, or returns the given 'default'. Superseded by someOrElse with better type inference. This method was left for binary compatibility.
Attributes
protected
final def someOrElseZIO[B, R1 <: R, E1 >: E, C](default: => ZIO[R1, E1, C])(implicit ev0: IsSubtypeOfOutput[A, Option[B]], ev1: <:<[C, B], trace: Trace): ZIO[R1, E1, B]
Extracts the optional value, or executes the effect 'default'.
final def someOrElseZIO[B, R1 <: R, E1 >: E](default: => ZIO[R1, E1, B])(implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZIO[R1, E1, B]
Extracts the optional value, or executes the effect 'default'.
Extracts the optional value, or executes the effect 'default'. Superseded by someOrElseZIO with better type inference. This method was left for binary compatibility.
Attributes
protected
final def someOrFail[B, E1 >: E](e: => E1)(implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZIO[R, E1, B]
Extracts the optional value, or fails with the given error 'e'.
final def someOrFailException[B, E1 >: E](implicit ev: IsSubtypeOfOutput[A, Option[B]], ev2: <:<[NoSuchElementException, E1], trace: Trace): ZIO[R, E1, B]
Extracts the optional value, or fails with a java.util.NoSuchElementException
final def someWith[R1, E1, A1, B, B1](f: (ZIO[R, Option[E], B]) => ZIO[R1, Option[E1], B1])(implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZIO[R1, E1, Option[B1]]
Perfoms the specified operation while "zoomed in" on the Some case of an Option.
final def summarized[R1 <: R, E1 >: E, B, C](summary0: => ZIO[R1, E1, B])(f: (B, B) => C)(implicit trace: Trace): ZIO[R1, E1, (C, A)]
Summarizes a effect by computing some value before and after execution, and then combining the values to produce a summary, together with the result of execution.
final def supervised(supervisor: => Supervisor[Any])(implicit trace: Trace): ZIO[R, E, A]
Returns an effect with the behavior of this one, but where all child fibers forked in the effect are reported to the specified supervisor.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
final def tap[R1 <: R, E1 >: E](f: (A) => ZIO[R1, E1, Any])(implicit trace: Trace): ZIO[R1, E1, A]
Returns an effect that effectfully "peeks" at the success of this effect.
Returns an effect that effectfully "peeks" at the success of this effect.
```
readFile("data.json").tap(printLine)
```
final def tapBoth[R1 <: R, E1 >: E](f: (E) => ZIO[R1, E1, Any], g: (A) => ZIO[R1, E1, Any])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E1, A]
Returns an effect that effectfully "peeks" at the failure or success of this effect.
Returns an effect that effectfully "peeks" at the failure or success of this effect.
```
readFile("data.json").tapBoth(logError(_), logData(_))
```
final def tapDefect[R1 <: R, E1 >: E](f: (Cause[Nothing]) => ZIO[R1, E1, Any])(implicit trace: Trace): ZIO[R1, E1, A]
Returns an effect that effectually "peeks" at the defect of this effect.
final def tapEither[R1 <: R, E1 >: E](f: (Either[E, A]) => ZIO[R1, E1, Any])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E1, A]
Returns an effect that effectfully "peeks" at the result of this effect.
Returns an effect that effectfully "peeks" at the result of this effect.
```
readFile("data.json").tapEither(result => log(result.fold("Error: " + _, "Success: " + _)))
```
final def tapError[R1 <: R, E1 >: E](f: (E) => ZIO[R1, E1, Any])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E1, A]
Returns an effect that effectfully "peeks" at the failure of this effect.
Returns an effect that effectfully "peeks" at the failure of this effect.
```
readFile("data.json").tapError(logError(_))
```
final def tapErrorCause[R1 <: R, E1 >: E](f: (Cause[E]) => ZIO[R1, E1, Any])(implicit trace: Trace): ZIO[R1, E1, A]
Returns an effect that effectually "peeks" at the cause of the failure of this effect.
Returns an effect that effectually "peeks" at the cause of the failure of this effect.
```
readFile("data.json").tapErrorCause(logCause(_))
```
final def tapErrorTrace[R1 <: R, E1 >: E](f: ((E, StackTrace)) => ZIO[R1, E1, Any])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E1, A]
A version of tapError that gives you the trace of the error.
final def tapSome[R1 <: R, E1 >: E](f: PartialFunction[A, ZIO[R1, E1, Any]])(implicit trace: Trace): ZIO[R1, E1, A]
Returns an effect that effectfully "peeks" at the success of this effect.
Returns an effect that effectfully "peeks" at the success of this effect. If the partial function isn't defined at the input, the result is equivalent to the original effect.
```
readFile("data.json").tapSome {
  case content if content.nonEmpty => putStrLn(content)
}
```
final def tapSomeError[R1 <: R, E1 >: E](f: PartialFunction[E, ZIO[R1, E1, Any]])(implicit ev: CanFail[E], trace: Trace): ZIO[R1, E1, A]
Returns an effect that effectfully "peeks" at the failure of this effect.
Returns an effect that effectfully "peeks" at the failure of this effect. If the partial function isn't defined at the input, the result is equivalent to the original effect.
final def timed(implicit trace: Trace): ZIO[R, E, (zio.Duration, A)]
Returns a new effect that executes this one and times the execution.
final def timedWith[R1 <: R, E1 >: E](nanoTime: => ZIO[R1, E1, Long])(implicit trace: Trace): ZIO[R1, E1, (zio.Duration, A)]
A more powerful variation of timed that allows specifying the workflow that will be used to calculate the current time.
final def timeout(d: => zio.Duration)(implicit trace: Trace): ZIO[R, E, Option[A]]
Returns an effect that will timeout this effect, returning None if the timeout elapses before the effect has produced a value; and returning Some of the produced value otherwise.
Returns an effect that will timeout this effect, returning None if the timeout elapses before the effect has produced a value; and returning Some of the produced value otherwise.
If the timeout elapses without producing a value, the running effect will be safely interrupted.
WARNING: The effect returned by this method will not itself return until the underlying effect is actually interrupted. This leads to more predictable resource utilization. If early return is desired, then instead of using effect.timeout(d), use effect.disconnect.timeout(d), which first disconnects the effect's interruption signal before performing the timeout, resulting in earliest possible return, before an underlying effect has been successfully interrupted.
final def timeoutFail[E1 >: E](e: => E1)(d: => zio.Duration)(implicit trace: Trace): ZIO[R, E1, A]
The same as timeout, but instead of producing a None in the event of timeout, it will produce the specified error.
final def timeoutFailCause[E1 >: E](cause: => Cause[E1])(d: => zio.Duration)(implicit trace: Trace): ZIO[R, E1, A]
The same as timeout, but instead of producing a None in the event of timeout, it will produce the specified failure.
final def timeoutTo[B](b: => B): TimeoutTo[R, E, A, B]
Returns an effect that will timeout this effect, returning either the default value if the timeout elapses before the effect has produced a value; and or returning the result of applying the function f to the success value of the effect.
Returns an effect that will timeout this effect, returning either the default value if the timeout elapses before the effect has produced a value; and or returning the result of applying the function f to the success value of the effect.
If the timeout elapses without producing a value, the running effect will be safely interrupted
```
ZIO.succeed(1).timeoutTo(None)(Some(_))(1.second)
```
def toCompletableFuture[A1 >: A](implicit ev: IsSubtypeOfError[E, Throwable], trace: Trace): URIO[R, CompletableFuture[A1]]
Definition Classes
ZIOPlatformSpecific
def toCompletableFutureWith[A1 >: A](f: (E) => Throwable)(implicit trace: Trace): URIO[R, CompletableFuture[A1]]
Definition Classes
ZIOPlatformSpecific
final def toFuture(implicit ev2: IsSubtypeOfError[E, Throwable], trace: Trace): URIO[R, CancelableFuture[A]]
Converts the effect into a scala.concurrent.Future.
final def toFutureWith(f: (E) => Throwable)(implicit trace: Trace): URIO[R, CancelableFuture[A]]
Converts the effect into a scala.concurrent.Future.
def toString(): String
Definition Classes
AnyRef → Any
final def uncause[E1 >: E](implicit ev: IsSubtypeOfOutput[A, Cause[E1]], trace: Trace): ZIO[R, E1, Unit]
When this effect succeeds with a cause, then this method returns a new effect that either fails with the cause that this effect succeeded with, or succeeds with unit, depending on whether the cause is empty.
When this effect succeeds with a cause, then this method returns a new effect that either fails with the cause that this effect succeeded with, or succeeds with unit, depending on whether the cause is empty.
This operation is the opposite of cause.
final def unexit[E1 >: E, A2](implicit ev: <:<[A, Exit[E1, A2]], trace: Trace): ZIO[R, E1, A2]
final def uninterruptible(implicit trace: Trace): ZIO[R, E, A]
Performs this effect uninterruptibly.
Performs this effect uninterruptibly. This will prevent the effect from being terminated externally, but the effect may fail for internal reasons (e.g. an uncaught error) or terminate due to defect.
Uninterruptible effects may recover from all failure causes (including interruption of an inner effect that has been made interruptible).
final def unit(implicit trace: Trace): ZIO[R, E, Unit]
Returns the effect resulting from mapping the success of this effect to unit.
final def unleft[E1, B](implicit ev: IsSubtypeOfError[E, Either[E1, B]], trace: Trace): ZIO[R, E1, Either[A, B]]
Converts a ZIO[R, Either[E, B], A] into a ZIO[R, E, Either[A, B]].
Converts a ZIO[R, Either[E, B], A] into a ZIO[R, E, Either[A, B]]. The inverse of left.
final def unless(p: => Boolean)(implicit trace: Trace): ZIO[R, E, Option[A]]
The moral equivalent of if (!p) Some(exp) else None
final def unlessDiscard(p: => Boolean)(implicit trace: Trace): ZIO[R, E, Unit]
The moral equivalent of if (!p) { expr; () }
final def unlessZIO[R1 <: R, E1 >: E](p: => ZIO[R1, E1, Boolean])(implicit trace: Trace): ZIO[R1, E1, Option[A]]
The moral equivalent of if (!p) Some(exp) else None when p has side-effects
final def unlessZIODiscard[R1 <: R, E1 >: E](p: => ZIO[R1, E1, Boolean])(implicit trace: Trace): ZIO[R1, E1, Unit]
The moral equivalent of if (!p) { expr; () } when p has side-effects
final def unrefine[E1 >: E](pf: PartialFunction[Throwable, E1])(implicit trace: Trace): ZIO[R, E1, A]
Takes some fiber failures and converts them into errors.
final def unrefineTo[E1 >: E](implicit arg0: ClassTag[E1], trace: Trace): ZIO[R, E1, A]
Takes some fiber failures and converts them into errors.
final def unrefineWith[E1](pf: PartialFunction[Throwable, E1])(f: (E) => E1)(implicit trace: Trace): ZIO[R, E1, A]
Takes some fiber failures and converts them into errors, using the specified function to convert the E into an E1.
final def unright[E1, B](implicit ev: IsSubtypeOfError[E, Either[B, E1]], trace: Trace): ZIO[R, E1, Either[B, A]]
Converts a ZIO[R, Either[B, E], A] into a ZIO[R, E, Either[B, A]].
Converts a ZIO[R, Either[B, E], A] into a ZIO[R, E, Either[B, A]]. The inverse of right.
final def unsandbox[E1](implicit ev: IsSubtypeOfError[E, Cause[E1]], trace: Trace): ZIO[R, E1, A]
The inverse operation to sandbox.
The inverse operation to sandbox. Submerges the full cause of failure.
final def unsome[E1](implicit ev: IsSubtypeOfError[E, Option[E1]], trace: Trace): ZIO[R, E1, Option[A]]
Converts an option on errors into an option on values.
final def updateService[M]: UpdateService[R, E, A, M]
Updates a service in the environment of this effect.
final def updateServiceAt[Service]: UpdateServiceAt[R, E, A, Service]
Updates a service at the specified key in the environment of this effect.
final def validate[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit zippable: Zippable[A, B], trace: Trace): ZIO[R1, E1, Out]
Sequentially zips the this result with the specified result.
Sequentially zips the this result with the specified result. Combines both Cause[E1] when both effects fail.
final def validatePar[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, (A, B)]
Returns an effect that executes both this effect and the specified effect, in parallel.
Returns an effect that executes both this effect and the specified effect, in parallel. Combines both Cause[E1]when both effects fail.
final def validateWith[R1 <: R, E1 >: E, B, C](that: => ZIO[R1, E1, B])(f: (A, B) => C)(implicit trace: Trace): ZIO[R1, E1, C]
Sequentially zips this effect with the specified effect using the specified combiner function.
Sequentially zips this effect with the specified effect using the specified combiner function. Combines the causes in case both effect fail.
final def validateWithPar[R1 <: R, E1 >: E, B, C](that: => ZIO[R1, E1, B])(f: (A, B) => C)(implicit trace: Trace): ZIO[R1, E1, C]
Returns an effect that executes both this effect and the specified effect, in parallel, combining their results with the specified f function.
Returns an effect that executes both this effect and the specified effect, in parallel, combining their results with the specified f function. If both sides fail, then the cause will be combined.
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def when(p: => Boolean)(implicit trace: Trace): ZIO[R, E, Option[A]]
The moral equivalent of if (p) Some(exp) else None
final def whenDiscard(p: => Boolean)(implicit trace: Trace): ZIO[R, E, Unit]
The moral equivalent of if (p) { expr; () }
final def whenFiberRef[S](ref: => FiberRef[S])(f: (S) => Boolean)(implicit trace: Trace): ZIO[R, E, (S, Option[A])]
Executes this workflow when value of the specified FiberRef satisfies the predicate.
final def whenRef[S](ref: => Ref[S])(f: (S) => Boolean)(implicit trace: Trace): ZIO[R, E, (S, Option[A])]
Executes this workflow when the value of the Ref satisfies the predicate.
final def whenZIO[R1 <: R, E1 >: E](p: => ZIO[R1, E1, Boolean])(implicit trace: Trace): ZIO[R1, E1, Option[A]]
The moral equivalent of if (p) Some(exp) else None when p has side-effects
final def whenZIODiscard[R1 <: R, E1 >: E](p: => ZIO[R1, E1, Boolean])(implicit trace: Trace): ZIO[R1, E1, Unit]
The moral equivalent of if (p) { expr; () } when p has side-effects
final def withClock[B <: Clock](clock: => B)(implicit tag: Tag[B], trace: Trace): ZIO[R, E, A]
Executes this workflow with the specified implementation of the clock service.
final def withConfigProvider[B <: ConfigProvider](configProvider: => B)(implicit tag: Tag[B], trace: Trace): ZIO[R, E, A]
Executes this workflow with the specified configuration provider.
final def withConsole[B <: Console](console: => B)(implicit tag: Tag[B], trace: Trace): ZIO[R, E, A]
Executes this workflow with the specified implementation of the console service.
final def withEarlyRelease(implicit trace: Trace): ZIO[R with Scope, E, (UIO[Unit], A)]
Returns a new scoped workflow that returns the result of this workflow as well as a finalizer that can be run to close the scope of this workflow.
final def withFinalizer[R1 <: R](finalizer: (A) => URIO[R1, Any])(implicit trace: Trace): ZIO[R1 with Scope, E, A]
Treats this effect as the acquisition of a resource and adds the specified finalizer to the current scope.
Treats this effect as the acquisition of a resource and adds the specified finalizer to the current scope. This effect will be run uninterruptibly and the finalizer will be run when the scope is closed.
final def withFinalizerExit[R1 <: R](finalizer: (A, Exit[Any, Any]) => URIO[R1, Any])(implicit trace: Trace): ZIO[R1 with Scope, E, A]
A more powerful variant of withFinalizer that allows the finalizer to depend on the Exit value that the scope is closed with.
final def withLogger[B <: ZLogger[String, Any]](logger: => B)(implicit tag: Tag[B], trace: Trace): ZIO[R, E, A]
Executes this workflow with the specified logger added.
final def withParallelism(n: => Int)(implicit trace: Trace): ZIO[R, E, A]
Runs this effect with the specified maximum number of fibers for parallel operators.
def withParallelismUnbounded(implicit trace: Trace): ZIO[R, E, A]
Runs this effect with an unbounded maximum number of fibers for parallel operators.
final def withRandom[B <: Random](random: => B)(implicit tag: Tag[B], trace: Trace): ZIO[R, E, A]
Executes this workflow with the specified implementation of the random service.
final def withRuntimeFlags(patch: Patch)(implicit trace: Trace): ZIO[R, E, A]
Returns a new ZIO effect that will update the runtime flags according to the specified patch within the scope of this ZIO effect.
final def withSystem[B <: System](system: => B)(implicit tag: Tag[B], trace: Trace): ZIO[R, E, A]
Executes this workflow with the specified implementation of the system service.
final def zip[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit zippable: Zippable[A, B], trace: Trace): ZIO[R1, E1, Out]
A named alias for <*>.
final def zipLeft[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, A]
A named alias for <*.
final def zipPar[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit zippable: Zippable[A, B], trace: Trace): ZIO[R1, E1, Out]
A named alias for <&>.
final def zipParLeft[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, A]
A named alias for <&.
final def zipParRight[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, B]
A named alias for &>.
final def zipRight[R1 <: R, E1 >: E, B](that: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, B]
A named alias for *>.
final def zipWith[R1 <: R, E1 >: E, B, C](that: => ZIO[R1, E1, B])(f: (A, B) => C)(implicit trace: Trace): ZIO[R1, E1, C]
Sequentially zips this effect with the specified effect using the specified combiner function.
final def zipWithPar[R1 <: R, E1 >: E, B, C](that: => ZIO[R1, E1, B])(f: (A, B) => C)(implicit trace: Trace): ZIO[R1, E1, C]
Returns an effect that executes both this effect and the specified effect, in parallel, combining their results with the specified f function.
Returns an effect that executes both this effect and the specified effect, in parallel, combining their results with the specified f function. If either side fails, then the other side will be interrupted.

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)
final def raceAwait[R1 <: R, E1 >: E, A1 >: A](that: => ZIO[R1, E1, A1])(implicit trace: Trace): ZIO[R1, E1, A1]
Annotations
@deprecated
Deprecated
(Since version 2.0.7) use race
final def raceFirstAwait[R1 <: R, E1 >: E, A1 >: A](that: => ZIO[R1, E1, A1])(implicit trace: Trace): ZIO[R1, E1, A1]
Annotations
@deprecated
Deprecated
(Since version 2.0.7) use raceFirst
final def unary_![R1 <: R, E1 >: E](implicit ev: <:<[A, Boolean], trace: Trace): ZIO[R1, E1, Boolean]
Returns the logical negation of the Boolean value returned by this effect.
Returns the logical negation of the Boolean value returned by this effect.
Annotations
@deprecated
Deprecated
(Since version 2.0.6) use negate

Packages

ZIO

Companion object ZIO

sealed trait ZIO[-R, +E, +A] extends Product with Serializable with ZIOPlatformSpecific[R, E, A] with ZIOVersionSpecific[R, E, A]

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from ZIOVersionSpecific[R, E, A]

Inherited from ZIOPlatformSpecific[R, E, A]

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

ZIO

Companion object ZIO

sealed trait ZIO[-R, +E, +A] extends Product with Serializable with ZIOPlatformSpecific[R, E, A] with ZIOVersionSpecific[R, E, A]

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from ZIOVersionSpecific[R, E, A]

Inherited from ZIOPlatformSpecific[R, E, A]

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

ZIO