ZManaged

sealed abstract class ZManaged[-R, +E, +A] extends ZManagedVersionSpecific[R, E, A] with Serializable

A ZManaged[R, E, A] is a managed resource of type A, which may be used by invoking the use method of the resource. The resource will be automatically acquired before the resource is used, and automatically released after the resource is used.

Resources do not survive the scope of use, meaning that if you attempt to capture the resource, leak it from use, and then use it after the resource has been consumed, the resource will not be valid anymore and may fail with some checked error, as per the type of the functions provided by the resource.

Companion:
object
class Object
trait Matchable
class Any
ZManaged[R, E, A]

Value members

Abstract methods

def zio: ZIO[R, E, (Finalizer, A)]

The ZIO value that underlies this ZManaged value. To evaluate it, a ReleaseMap is required. The ZIO value will return a tuple of the resource allocated by this ZManaged and a finalizer that will release the resource.

The ZIO value that underlies this ZManaged value. To evaluate it, a ReleaseMap is required. The ZIO value will return a tuple of the resource allocated by this ZManaged and a finalizer that will release the resource.

Note that this method is a low-level interface, not intended for regular usage. As such, it offers no guarantees on interruption or resource safety

  • those are up to the caller to enforce!

Concrete methods

final def !(implicit ev1: E <:< Throwable, ev2: CanFail[E], trace: Trace): ZManaged[R, Nothing, A]

A symbolic alias for orDie.

A symbolic alias for orDie.

def &>[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit trace: Trace): ZManaged[R1, E1, A1]

Symbolic alias for zipParRight

Symbolic alias for zipParRight

def *>[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit trace: Trace): ZManaged[R1, E1, A1]

Symbolic alias for zipRight

Symbolic alias for zipRight

def <&[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit trace: Trace): ZManaged[R1, E1, A]

Symbolic alias for zipParLeft

Symbolic alias for zipParLeft

def <&>[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit zippable: Zippable[A, A1], trace: Trace): ZManaged[R1, E1, Out]

Symbolic alias for zipPar

Symbolic alias for zipPar

def <*[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit trace: Trace): ZManaged[R1, E1, A]

Symbolic alias for zipLeft.

Symbolic alias for zipLeft.

def <*>[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit zippable: Zippable[A, A1], trace: Trace): ZManaged[R1, E1, Out]

Symbolic alias for zip.

Symbolic alias for zip.

def <>[R1 <: R, E2, A1 >: A](that: => ZManaged[R1, E2, A1])(implicit ev: CanFail[E], trace: Trace): ZManaged[R1, E2, A1]

Operator alias for orElse.

Operator alias for orElse.

final def @@[LowerR <: UpperR, UpperR <: R, LowerE >: E, UpperE >: LowerE, LowerA >: A, UpperA >: LowerA](aspect: => ZManagedAspect[LowerR, UpperR, LowerE, UpperE, LowerA, UpperA])(implicit trace: Trace): ZManaged[UpperR, LowerE, LowerA]

Syntax for adding aspects.

Syntax for adding aspects.

def absolve[E1 >: E, B](implicit ev: IsSubtypeOfOutput[A, Either[E1, B]], trace: Trace): ZManaged[R, E1, B]

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

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

def absorb(implicit ev: IsSubtypeOfError[E, Throwable], trace: Trace): ZManaged[R, Throwable, A]

Attempts to convert defects into a failure, throwing away all information about the cause of the failure.

Attempts to convert defects into a failure, throwing away all information about the cause of the failure.

def absorbWith(f: E => Throwable)(implicit trace: Trace): ZManaged[R, Throwable, A]

Attempts to convert defects into a failure, throwing away all information about the cause of the failure.

Attempts to convert defects into a failure, throwing away all information about the cause of the failure.

def as[B](b: => B)(implicit trace: Trace): ZManaged[R, E, B]

Maps this effect to the specified constant while preserving the effects of this effect.

Maps this effect to the specified constant while preserving the effects of this effect.

final def asSome(implicit trace: Trace): ZManaged[R, E, Option[A]]

Maps the success value of this effect to an optional value.

Maps the success value of this effect to an optional value.

final def asSomeError(implicit trace: Trace): ZManaged[R, Option[E], A]

Maps the error value of this effect to an optional value.

Maps the error value of this effect to an optional value.

def catchAll[R1 <: R, E2, A1 >: A](h: E => ZManaged[R1, E2, A1])(implicit ev: CanFail[E], trace: Trace): ZManaged[R1, E2, A1]

Recovers from all errors.

Recovers from all errors.

def catchAllCause[R1 <: R, E2, A1 >: A](h: Cause[E] => ZManaged[R1, E2, A1])(implicit trace: Trace): ZManaged[R1, E2, A1]

Recovers from all errors with provided Cause.

Recovers from all errors with provided Cause.

managed.catchAllCause(_ => ZManaged.succeed(defaultConfig))
See also:

absorb, sandbox, mapErrorCause - other functions that can recover from defects

def catchSome[R1 <: R, E1 >: E, A1 >: A](pf: PartialFunction[E, ZManaged[R1, E1, A1]])(implicit ev: CanFail[E], trace: Trace): ZManaged[R1, E1, A1]

Recovers from some or all of the error cases.

Recovers from some or all of the error cases.

def catchSomeCause[R1 <: R, E1 >: E, A1 >: A](pf: PartialFunction[Cause[E], ZManaged[R1, E1, A1]])(implicit trace: Trace): ZManaged[R1, E1, A1]

Recovers from some or all of the error Causes.

Recovers from some or all of the error Causes.

def collect[E1 >: E, B](e: => E1)(pf: PartialFunction[A, B])(implicit trace: Trace): ZManaged[R, E1, B]

Fail with e if the supplied PartialFunction does not match, otherwise succeed with the returned value.

Fail with e if the supplied PartialFunction does not match, otherwise succeed with the returned value.

def collectManaged[R1 <: R, E1 >: E, B](e: => E1)(pf: PartialFunction[A, ZManaged[R1, E1, B]])(implicit trace: Trace): ZManaged[R1, E1, B]

Fail with e if the supplied PartialFunction does not match, otherwise continue with the returned value.

Fail with e if the supplied PartialFunction does not match, otherwise continue with the returned value.

def either(implicit ev: CanFail[E], trace: Trace): ZManaged[R, Nothing, Either[E, A]]

Returns an effect whose failure and success have been lifted into an Either.The resulting effect cannot fail

Returns an effect whose failure and success have been lifted into an Either.The resulting effect cannot fail

def ensuring[R1 <: R](f: => ZIO[R1, Nothing, Any])(implicit trace: Trace): ZManaged[R1, E, A]

Ensures that f is executed when this ZManaged is finalized, after the existing finalizer.

Ensures that f is executed when this ZManaged is finalized, after the existing finalizer.

For usecases that need access to the ZManaged's result, see ZManaged#onExit.

def ensuringFirst[R1 <: R](f: => ZIO[R1, Nothing, Any])(implicit trace: Trace): ZManaged[R1, E, A]

Ensures that f is executed when this ZManaged is finalized, before the existing finalizer.

Ensures that f is executed when this ZManaged is finalized, before the existing finalizer.

For usecases that need access to the ZManaged's result, see ZManaged#onExitFirst.

def eventually(implicit ev: CanFail[E], trace: Trace): ZManaged[R, Nothing, A]

Returns a ZManaged that ignores errors raised by the acquire effect and runs it repeatedly until it eventually succeeds.

Returns a ZManaged that ignores errors raised by the acquire effect and runs it repeatedly until it eventually succeeds.

def exit(implicit trace: Trace): ZManaged[R, Nothing, 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.

Returns an effect that semantically runs the effect on a fiber, producing an zio.Exit for the completion value of the fiber.

final def firstSuccessOf[R1 <: R, E1 >: E, A1 >: A](rest: => Iterable[ZManaged[R1, E1, A1]])(implicit trace: Trace): ZManaged[R1, E1, A1]

Returns a managed resource that attempts to acquire this managed resource and in case of failure, attempts to acquire each of the specified managed resources in order until one of them is successfully acquired, ensuring that the acquired resource is properly released after being used.

Returns a managed resource that attempts to acquire this managed resource and in case of failure, attempts to acquire each of the specified managed resources in order until one of them is successfully acquired, ensuring that the acquired resource is properly released after being used.

def flatMap[R1 <: R, E1 >: E, B](f: A => ZManaged[R1, E1, B])(implicit trace: Trace): ZManaged[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.

def flatMapError[R1 <: R, E2](f: E => ZManaged[R1, Nothing, E2])(implicit ev: CanFail[E], trace: Trace): ZManaged[R1, E2, A]

Effectfully map the error channel

Effectfully map the error channel

def flatten[R1 <: R, E1 >: E, B](implicit ev: IsSubtypeOfOutput[A, ZManaged[R1, E1, B]], trace: Trace): ZManaged[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.

def flattenZIO[R1 <: R, E1 >: E, B](implicit ev: IsSubtypeOfOutput[A, ZIO[R1, E1, B]], trace: Trace): ZManaged[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.

def flip(implicit trace: Trace): ZManaged[R, A, E]

Flip the error and result

Flip the error and result

def flipWith[R1, A1, E1](f: ZManaged[R, A, E] => ZManaged[R1, A1, E1])(implicit trace: Trace): ZManaged[R1, E1, A1]

Flip the error and result, then apply an effectful function to the effect

Flip the error and result, then apply an effectful function to the effect

def fold[B](failure: E => B, success: A => B)(implicit ev: CanFail[E], trace: Trace): ZManaged[R, Nothing, 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.

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.

def foldCause[B](failure: Cause[E] => B, success: A => B)(implicit trace: Trace): ZManaged[R, Nothing, B]

A more powerful version of fold that allows recovering from any kind of failure except interruptions.

A more powerful version of fold that allows recovering from any kind of failure except interruptions.

def foldCauseManaged[R1 <: R, E1, A1](failure: Cause[E] => ZManaged[R1, E1, A1], success: A => ZManaged[R1, E1, A1])(implicit trace: Trace): ZManaged[R1, E1, A1]

A more powerful version of foldManaged that allows recovering from any kind of failure except interruptions.

A more powerful version of foldManaged that allows recovering from any kind of failure except interruptions.

def foldManaged[R1 <: R, E2, B](failure: E => ZManaged[R1, E2, B], success: A => ZManaged[R1, E2, B])(implicit ev: CanFail[E], trace: Trace): ZManaged[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.

def fork(implicit trace: Trace): ZManaged[R, Nothing, Runtime[E, A]]

Creates a ZManaged value that acquires the original resource in a fiber, and provides that fiber. The finalizer for this value will interrupt the fiber and run the original finalizer.

Creates a ZManaged value that acquires the original resource in a fiber, and provides that fiber. The finalizer for this value will interrupt the fiber and run the original finalizer.

def ignore(implicit trace: Trace): ZManaged[R, Nothing, Unit]

Returns a new effect that ignores the success or failure of this effect.

Returns a new effect that ignores the success or failure of this effect.

def ignoreReleaseFailures(implicit trace: Trace): ZManaged[R, E, A]

Returns a new managed effect that ignores defects in finalizers.

Returns a new managed effect that ignores defects in finalizers.

def isFailure(implicit trace: Trace): ZManaged[R, Nothing, Boolean]

Returns whether this managed effect is a failure.

Returns whether this managed effect is a failure.

def isSuccess(implicit trace: Trace): ZManaged[R, Nothing, Boolean]

Returns whether this managed effect is a success.

Returns whether this managed effect is a success.

def map[B](f: A => B)(implicit trace: Trace): ZManaged[R, E, B]

Returns an effect whose success is mapped by the specified f function.

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): ZManaged[R, Throwable, B]

Returns an effect whose success is mapped by the specified side effecting f function, translating any thrown exceptions into typed failed effects.

Returns an effect whose success is mapped by the specified side effecting f function, translating any thrown exceptions into typed failed effects.

def mapBoth[E1, A1](f: E => E1, g: A => A1)(implicit ev: CanFail[E], trace: Trace): ZManaged[R, E1, A1]

Returns an effect whose failure and success channels have been mapped by the specified pair of functions, f and g.

Returns an effect whose failure and success channels have been mapped by the specified pair of functions, f and g.

def mapError[E1](f: E => E1)(implicit ev: CanFail[E], trace: Trace): ZManaged[R, E1, A]

Returns an effect whose failure is mapped by the specified f function.

Returns an effect whose failure is mapped by the specified f function.

def mapErrorCause[E1](f: Cause[E] => Cause[E1])(implicit trace: Trace): ZManaged[R, E1, A]

Returns an effect whose full failure is mapped by the specified f function.

Returns an effect whose full failure is mapped by the specified f function.

def mapZIO[R1 <: R, E1 >: E, B](f: A => ZIO[R1, E1, B])(implicit trace: Trace): ZManaged[R1, E1, B]

Effectfully maps the resource acquired by this value.

Effectfully maps the resource acquired by this value.

def memoize(implicit trace: Trace): ZManaged[Any, Nothing, ZManaged[R, E, A]]
def merge[A1 >: A](implicit ev1: IsSubtypeOfError[E, A1], ev2: CanFail[E], trace: Trace): ZManaged[R, Nothing, A1]

Returns a new effect where the error channel has been merged into the success channel to their common combined type.

Returns a new effect where the error channel has been merged into the success channel to their common combined type.

final def none[B](implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZManaged[R, Option[E], Unit]

Requires the option produced by this value to be None.

Requires the option produced by this value to be None.

final def onExecutionContext(ec: => ExecutionContext)(implicit trace: Trace): ZManaged[R, E, A]

Runs this managed effect, as well as any managed effects that are composed sequentially after it, using the specified ExecutionContext.

Runs this managed effect, as well as any managed effects that are composed sequentially after it, using the specified ExecutionContext.

final def onExecutor(executor: => Executor)(implicit trace: Trace): ZManaged[R, E, A]

Locks this managed effect to the specified executor, guaranteeing that this managed effect as well as managed effects that are composed sequentially after it will be run on the specified executor.

Locks this managed effect to the specified executor, guaranteeing that this managed effect as well as managed effects that are composed sequentially after it will be run on the specified executor.

def onExit[R1 <: R](cleanup: Exit[E, A] => ZIO[R1, Nothing, Any])(implicit trace: Trace): ZManaged[R1, E, A]

Ensures that a cleanup function runs when this ZManaged is finalized, after the existing finalizers.

Ensures that a cleanup function runs when this ZManaged is finalized, after the existing finalizers.

def onExitFirst[R1 <: R](cleanup: Exit[E, A] => ZIO[R1, Nothing, Any])(implicit trace: Trace): ZManaged[R1, E, A]

Ensures that a cleanup function runs when this ZManaged is finalized, before the existing finalizers.

Ensures that a cleanup function runs when this ZManaged is finalized, before the existing finalizers.

def option(implicit ev: CanFail[E], trace: Trace): ZManaged[R, Nothing, Option[A]]

Executes this effect, skipping the error but returning optionally the success.

Executes this effect, skipping the error but returning optionally the success.

def orDie(implicit ev1: IsSubtypeOfError[E, Throwable], ev2: CanFail[E], trace: Trace): ZManaged[R, Nothing, A]

Translates effect failure into death of the fiber, making all failures unchecked and not a part of the type of the effect.

Translates effect failure into death of the fiber, making all failures unchecked and not a part of the type of the effect.

def orDieWith(f: E => Throwable)(implicit ev: CanFail[E], trace: Trace): ZManaged[R, Nothing, A]

Keeps none of the errors, and terminates the fiber with them, using the specified function to convert the E into a Throwable.

Keeps none of the errors, and terminates the fiber with them, using the specified function to convert the E into a Throwable.

def orElse[R1 <: R, E2, A1 >: A](that: => ZManaged[R1, E2, A1])(implicit ev: CanFail[E], trace: Trace): ZManaged[R1, E2, A1]

Executes this effect and returns its value, if it succeeds, but otherwise executes the specified effect.

Executes this effect and returns its value, if it succeeds, but otherwise executes the specified effect.

def orElseEither[R1 <: R, E2, B](that: => ZManaged[R1, E2, B])(implicit ev: CanFail[E], trace: Trace): ZManaged[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.

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.

final def orElseFail[E1](e1: => E1)(implicit ev: CanFail[E], trace: Trace): ZManaged[R, E1, A]

Executes this effect and returns its value, if it succeeds, but otherwise fails with the specified error.

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: => ZManaged[R1, Option[E1], A1])(implicit ev: IsSubtypeOfError[E, Option[E1]], trace: Trace): ZManaged[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.

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): ZManaged[R, Nothing, A1]

Executes this effect and returns its value, if it succeeds, but otherwise succeeds with the specified value.

Executes this effect and returns its value, if it succeeds, but otherwise succeeds with the specified value.

def preallocate(implicit trace: Trace): ZIO[R, E, Managed[Nothing, A]]

Preallocates the managed resource, resulting in a ZManaged that reserves and acquires immediately and cannot fail. You should take care that you are not interrupted between running preallocate and actually acquiring the resource as you might leak otherwise.

Preallocates the managed resource, resulting in a ZManaged that reserves and acquires immediately and cannot fail. You should take care that you are not interrupted between running preallocate and actually acquiring the resource as you might leak otherwise.

def preallocateManaged(implicit trace: Trace): ZManaged[R, E, Managed[Nothing, A]]

Preallocates the managed resource inside an outer managed, resulting in a ZManaged that reserves and acquires immediately and cannot fail.

Preallocates the managed resource inside an outer managed, resulting in a ZManaged that reserves and acquires immediately and cannot fail.

def provideEnvironment(r: => ZEnvironment[R])(implicit trace: Trace): Managed[E, A]

Provides the ZManaged effect with its required environment, which eliminates its dependency on R.

Provides the ZManaged 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): ZManaged[R0, E1, A]

Provides a layer to the ZManaged, which translates it to another level.

Provides a layer to the ZManaged, which translates it to another level.

def provideSomeEnvironment[R0](f: ZEnvironment[R0] => ZEnvironment[R])(implicit trace: Trace): ZManaged[R0, E, A]

Transforms the environment being provided to this effect with the specified function.

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 loggingLayer: ZLayer[Any, Nothing, Logging] = ???

val managed: ZManaged[Logging with Database, Nothing, Unit] = ???

val managed2 = managed.provideSomeLayer[Database](loggingLayer)
def refineOrDie[E1](pf: PartialFunction[E, E1])(implicit ev1: IsSubtypeOfError[E, Throwable], ev2: CanFail[E], trace: Trace): ZManaged[R, E1, A]

Keeps some of the errors, and terminates the fiber with the rest.

Keeps some of the errors, and terminates the fiber with the rest.

def refineOrDieWith[E1](pf: PartialFunction[E, E1])(f: E => Throwable)(implicit ev: CanFail[E], trace: Trace): ZManaged[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.

Keeps some of the errors, and terminates the fiber with the rest, using the specified function to convert the E into a Throwable.

def refineToOrDie[E1 <: E : ClassTag](implicit evidence$6: ClassTag[E1], ev: CanFail[E], trace: Trace): ZManaged[R, E1, A]
Implicitly added by RefineToOrDieOps

Keeps some of the errors, and terminates the fiber with the rest.

Keeps some of the errors, and terminates the fiber with the rest.

def reject[E1 >: E](pf: PartialFunction[A, E1])(implicit trace: Trace): ZManaged[R, E1, A]

Fail with the returned value if the PartialFunction matches, otherwise continue with our held value.

Fail with the returned value if the PartialFunction matches, otherwise continue with our held value.

def rejectManaged[R1 <: R, E1 >: E](pf: PartialFunction[A, ZManaged[R1, E1, E1]])(implicit trace: Trace): ZManaged[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.

Continue with the returned computation if the PartialFunction matches, translating the successful match into a failure, otherwise continue with our held value.

def release(implicit trace: Trace): ZManaged[R, E, A]

Runs all the finalizers associated with this scope. This is useful to conceptually "close" a scope when composing multiple managed effects. Note that this is only safe if the result of this managed effect is valid outside its scope.

Runs all the finalizers associated with this scope. This is useful to conceptually "close" a scope when composing multiple managed effects. Note that this is only safe if the result of this managed effect is valid outside its scope.

def reserve(implicit trace: Trace): UIO[Reservation[R, E, A]]

Returns a Reservation that allows separately accessing effects describing resource acquisition and release.

Returns a Reservation that allows separately accessing effects describing resource acquisition and release.

def retry[R1 <: R, S](policy: => Schedule[R1, E, S])(implicit ev: CanFail[E], trace: Trace): ZManaged[R1, E, A]

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".

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".

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

Exposes the full cause of failure of this effect.

Exposes the full cause of failure of this effect.

def sandboxWith[R1 <: R, E2, B](f: ZManaged[R1, Cause[E], A] => ZManaged[R1, Cause[E2], B])(implicit trace: Trace): ZManaged[R1, E2, B]

Companion helper to sandbox. Allows recovery, and partial recovery, from errors and defects alike.

Companion helper to sandbox. Allows recovery, and partial recovery, from errors and defects alike.

def scoped(implicit trace: Trace): ZIO[R & Scope, E, A]
final def some[B](implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZManaged[R, Option[E], B]

Converts an option on values into an option on errors.

Converts an option on values into an option on errors.

final def someOrElse[B](default: => B)(implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZManaged[R, E, B]

Extracts the optional value, or returns the given 'default'.

Extracts the optional value, or returns the given 'default'.

final def someOrElseManaged[B, R1 <: R, E1 >: E](default: => ZManaged[R1, E1, B])(implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZManaged[R1, E1, B]

Extracts the optional value, or executes the effect 'default'.

Extracts the optional value, or executes the effect 'default'.

final def someOrFail[B, E1 >: E](e: => E1)(implicit ev: IsSubtypeOfOutput[A, Option[B]], trace: Trace): ZManaged[R, E1, B]

Extracts the optional value, or fails with the given error 'e'.

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): ZManaged[R, E1, B]

Extracts the optional value, or fails with a java.util.NoSuchElementException

Extracts the optional value, or fails with a java.util.NoSuchElementException

def tap[R1 <: R, E1 >: E](f: A => ZManaged[R1, E1, Any])(implicit trace: Trace): ZManaged[R1, E1, A]

Returns an effect that effectfully peeks at the acquired resource.

Returns an effect that effectfully peeks at the acquired resource.

def tapBoth[R1 <: R, E1 >: E](f: E => ZManaged[R1, E1, Any], g: A => ZManaged[R1, E1, Any])(implicit ev: CanFail[E], trace: Trace): ZManaged[R1, E1, A]

Returns an effect that effectfully peeks at the failure or success of the acquired resource.

Returns an effect that effectfully peeks at the failure or success of the acquired resource.

final def tapDefect[R1 <: R, E1 >: E](f: Cause[Nothing] => ZManaged[R1, E1, Any])(implicit trace: Trace): ZManaged[R1, E1, A]

Returns an effect that effectually "peeks" at the defect of the acquired resource.

Returns an effect that effectually "peeks" at the defect of the acquired resource.

def tapError[R1 <: R, E1 >: E](f: E => ZManaged[R1, E1, Any])(implicit ev: CanFail[E], trace: Trace): ZManaged[R1, E1, A]

Returns an effect that effectfully peeks at the failure of the acquired resource.

Returns an effect that effectfully peeks at the failure of the acquired resource.

final def tapErrorCause[R1 <: R, E1 >: E](f: Cause[E] => ZManaged[R1, E1, Any])(implicit trace: Trace): ZManaged[R1, E1, A]

Returns an effect that effectually peeks at the cause of the failure of the acquired resource.

Returns an effect that effectually peeks at the cause of the failure of the acquired resource.

def tapZIO[R1 <: R, E1 >: E](f: A => ZIO[R1, E1, Any])(implicit trace: Trace): ZManaged[R1, E1, A]

Like ZManaged#tap, but uses a function that returns a ZIO value rather than a ZManaged value.

Like ZManaged#tap, but uses a function that returns a ZIO value rather than a ZManaged value.

def timed(implicit trace: Trace): ZManaged[R, E, (Duration, A)]

Returns a new effect that executes this one and times the acquisition of the resource.

Returns a new effect that executes this one and times the acquisition of the resource.

def timeout(d: => Duration)(implicit trace: Trace): ZManaged[R, E, Option[A]]

Returns an effect that will timeout this resource, returning None if the timeout elapses before the resource was reserved and acquired. If the reservation completes successfully (even after the timeout) the release action will be run on a new fiber. Some will be returned if acquisition and reservation complete in time

Returns an effect that will timeout this resource, returning None if the timeout elapses before the resource was reserved and acquired. If the reservation completes successfully (even after the timeout) the release action will be run on a new fiber. Some will be returned if acquisition and reservation complete in time

def toLayer[A1 >: A : Tag](implicit evidence$1: Tag[A1], trace: Trace): ZLayer[R, E, A1]

Constructs a layer from this managed resource.

Constructs a layer from this managed resource.

final def toLayerEnvironment[B](implicit ev: A <:< ZEnvironment[B], trace: Trace): ZLayer[R, E, B]

Constructs a layer from this managed resource, which must return one or more services.

Constructs a layer from this managed resource, which must return one or more services.

def unit(implicit trace: Trace): ZManaged[R, E, Unit]

Return unit while running the effect

Return unit while running the effect

final def unless(b: => Boolean)(implicit trace: Trace): ZManaged[R, E, Option[A]]

The moral equivalent of if (!p) exp

The moral equivalent of if (!p) exp

final def unlessManaged[R1 <: R, E1 >: E](b: => ZManaged[R1, E1, Boolean])(implicit trace: Trace): ZManaged[R1, E1, Option[A]]

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

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

def unsandbox[E1](implicit ev: IsSubtypeOfError[E, Cause[E1]], trace: Trace): ZManaged[R, E1, A]

The inverse operation ZManaged.sandboxed

The inverse operation ZManaged.sandboxed

final def unsome[E1](implicit ev: IsSubtypeOfError[E, Option[E1]], trace: Trace): ZManaged[R, E1, Option[A]]

Converts an option on errors into an option on values.

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.

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.

Updates a service at the specified key in the environment of this effect.

def use[R1 <: R, E1 >: E, B](f: A => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, B]

Run an effect while acquiring the resource before and releasing it after

Run an effect while acquiring the resource before and releasing it after

def useDiscard[R1 <: R, E1 >: E, B](f: => ZIO[R1, E1, B])(implicit trace: Trace): ZIO[R1, E1, B]

Run an effect while acquiring the resource before and releasing it after. This does not provide the resource to the function

Run an effect while acquiring the resource before and releasing it after. This does not provide the resource to the function

def useForever(implicit trace: Trace): ZIO[R, E, Nothing]

Use the resource until interruption. Useful for resources that you want to acquire and use as long as the application is running, like a HTTP server.

Use the resource until interruption. Useful for resources that you want to acquire and use as long as the application is running, like a HTTP server.

def useNow(implicit trace: Trace): ZIO[R, E, A]

Runs the acquire and release actions and returns the result of this managed effect. Note that this is only safe if the result of this managed effect is valid outside its scope.

Runs the acquire and release actions and returns the result of this managed effect. Note that this is only safe if the result of this managed effect is valid outside its scope.

def when(b: => Boolean)(implicit trace: Trace): ZManaged[R, E, Option[A]]

The moral equivalent of if (p) exp

The moral equivalent of if (p) exp

def whenManaged[R1 <: R, E1 >: E](b: => ZManaged[R1, E1, Boolean])(implicit trace: Trace): ZManaged[R1, E1, Option[A]]

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

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

def withEarlyRelease(implicit trace: Trace): ZManaged[R, E, (UIO[Any], A)]

Modifies this ZManaged to provide a canceler that can be used to eagerly execute the finalizer of this ZManaged. The canceler will run uninterruptibly with an exit value indicating that the effect was interrupted, and if completed will cause the regular finalizer to not run.

Modifies this ZManaged to provide a canceler that can be used to eagerly execute the finalizer of this ZManaged. The canceler will run uninterruptibly with an exit value indicating that the effect was interrupted, and if completed will cause the regular finalizer to not run.

def withEarlyReleaseExit(e: => Exit[Any, Any])(implicit trace: Trace): ZManaged[R, E, (UIO[Any], A)]

A more powerful version of withEarlyRelease that allows specifying an exit value in the event of early release.

A more powerful version of withEarlyRelease that allows specifying an exit value in the event of early release.

def withParallelism(n: => Int)(implicit trace: Trace): ZManaged[R, E, A]

Runs this managed effect with the specified maximum number of fibers for parallel operators, guaranteeing that this managed effect as well as managed effects that are composed sequentially after it will be run with the specified maximum number of fibers for parallel operators.

Runs this managed effect with the specified maximum number of fibers for parallel operators, guaranteeing that this managed effect as well as managed effects that are composed sequentially after it will be run with the specified maximum number of fibers for parallel operators.

def withParallelismUnbounded(implicit trace: Trace): ZManaged[R, E, A]

Runs this managed effect with an unbounded maximum number of fibers for parallel operators, guaranteeing that this managed effect as well as managed effects that are composed sequentially after it will be run with an unbounded maximum number of fibers for parallel operators.

Runs this managed effect with an unbounded maximum number of fibers for parallel operators, guaranteeing that this managed effect as well as managed effects that are composed sequentially after it will be run with an unbounded maximum number of fibers for parallel operators.

def zip[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit zippable: Zippable[A, A1], trace: Trace): ZManaged[R1, E1, Out]

Named alias for <*>.

Named alias for <*>.

def zipLeft[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit trace: Trace): ZManaged[R1, E1, A]

Named alias for <*.

Named alias for <*.

def zipPar[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit zippable: Zippable[A, A1], trace: Trace): ZManaged[R1, E1, Out]

Named alias for <&>.

Named alias for <&>.

def zipParLeft[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit trace: Trace): ZManaged[R1, E1, A]

Named alias for <&.

Named alias for <&.

def zipParRight[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit trace: Trace): ZManaged[R1, E1, A1]

Named alias for &>.

Named alias for &>.

def zipRight[R1 <: R, E1 >: E, A1](that: => ZManaged[R1, E1, A1])(implicit trace: Trace): ZManaged[R1, E1, A1]

Named alias for *>.

Named alias for *>.

def zipWith[R1 <: R, E1 >: E, A1, A2](that: => ZManaged[R1, E1, A1])(f: (A, A1) => A2)(implicit trace: Trace): ZManaged[R1, E1, A2]

Returns an effect that executes both this effect and the specified effect, in sequence, combining their results with the specified f function.

Returns an effect that executes both this effect and the specified effect, in sequence, combining their results with the specified f function.

def zipWithPar[R1 <: R, E1 >: E, A1, A2](that: => ZManaged[R1, E1, A1])(f: (A, A1) => A2)(implicit trace: Trace): ZManaged[R1, E1, A2]

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.

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.

Inherited methods

inline def provide[E1 >: E](inline layer: ZLayer[_, E1, _]*): ZManaged[Any, E1, A]

Automatically assembles a layer for the ZManaged effect, which translates it to another level.

Automatically assembles a layer for the ZManaged effect, which translates it to another level.

Inherited from:
ZManagedVersionSpecific

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 managed: ZIO[Clock with Random, Nothing, Unit] = ???

val managed2 = managed.provideSome[Random](clockLayer)
Inherited from:
ZManagedVersionSpecific