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
Value members
Abstract methods
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
Splits the environment, providing the first part to this effect and the second part to that effect.
Splits the environment, providing the first part to this effect and the second part to that effect.
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.
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.
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.
Executes the this effect and then provides its output as an environment to the second effect
Executes the this effect and then provides its output as an environment to the second effect
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.
Maps the success value of this effect to a service.
Maps the success value of this effect to a service.
Maps the success value of this effect to an optional value.
Maps the success value of this effect to an optional value.
Maps the error value of this effect to an optional value.
Maps the error value of this effect to an optional value.
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
Recovers from some or all of the error cases.
Recovers from some or all of the error cases.
Recovers from some or all of the error Causes.
Recovers from some or all of the error Causes.
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.
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.
Executes the second effect and then provides its output as an environment to this effect
Executes the second effect and then provides its output as an environment to this effect
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
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.
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.
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.
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.
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.
Effectfully map the error channel
Effectfully map the error channel
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.
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.
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
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.
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.
A more powerful version of foldM that allows recovering from any kind of
failure except interruptions.
A more powerful version of foldM that allows recovering from any kind of
failure except interruptions.
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.
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.
Unwraps the optional success of this effect, but can fail with None value.
Unwraps the optional success of this effect, but can fail with None value.
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.
Depending on the environment execute this or the other effect
Depending on the environment execute this or the other effect
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.
Returns an effect whose success is mapped by the specified f function.
Returns an effect whose success is mapped by the specified f function.
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.
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.
Returns an effect whose failure is mapped by the specified f function.
Returns an effect whose failure is mapped by the specified f function.
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.
Effectfully maps the resource acquired by this value.
Effectfully maps the resource acquired by this value.
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.
Requires the option produced by this value to be None.
Requires the option produced by this value to be None.
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.
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.
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.
Executes this effect, skipping the error but returning optionally the success.
Executes this effect, skipping the error but returning optionally the success.
Converts an option on errors into an option on values.
Converts an option on errors into an option on values.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Provides the part of the environment that is not part of the ZEnv,
leaving a managed effect that only depends on the ZEnv.
Provides the part of the environment that is not part of the ZEnv,
leaving a managed effect that only depends on the ZEnv.
val loggingLayer: ZLayer[Any, Nothing, Logging] = ???
val managed: ZManaged[ZEnv with Logging, Nothing, Unit] = ???
val managed2 = managed.provideCustomLayer(loggingLayer)
Provides a layer to the ZManaged, which translates it to another level.
Provides a layer to the ZManaged, which translates it to another level.
Provides some of the environment required to run this effect, leaving the
remainder R0.
Provides some of the environment required to run this effect, leaving the
remainder R0.
val managed: ZManaged[Console with Logging, Nothing, Unit] = ???
managed.provideSome[Console](env =>
new Console with Logging {
val console = env.console
val logging = new Logging.Service[Any] {
def log(line: String) = console.putStrLn(line)
}
}
)
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 clockLayer: ZLayer[Any, Nothing, Clock] = ???
val managed: ZManaged[Clock with Random, Nothing, Unit] = ???
val managed2 = managed.provideSomeLayer[Random](clockLayer)
Keeps some of the errors, and terminates the fiber with the rest.
Keeps some of the errors, and terminates the fiber with the rest.
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.
Keeps some of the errors, and terminates the fiber with the rest.
Keeps some of the errors, and terminates the fiber with the rest.
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.
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.
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.
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.
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".
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.
Converts an option on values into an option on errors.
Converts an option on values into an option on errors.
Extracts the optional value, or returns the given 'default'.
Extracts the optional value, or returns the given 'default'.
Extracts the optional value, or executes the effect 'default'.
Extracts the optional value, or executes the effect 'default'.
Extracts the optional value, or fails with the given error 'e'.
Extracts the optional value, or fails with the given error 'e'.
Extracts the optional value, or fails with a java.util.NoSuchElementException
Extracts the optional value, or fails with a java.util.NoSuchElementException
Returns an effect that effectfully peeks at the acquired resource.
Returns an effect that effectfully peeks at the acquired resource.
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.
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.
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.
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.
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.
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.
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
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.
The moral equivalent of if (!p) exp when p has side-effects
The moral equivalent of if (!p) exp when p has side-effects
Updates a service in the environment of this effect.
Updates a service in the environment of this effect.
Run an effect while acquiring the resource before and releasing it after
Run an effect while acquiring the resource before and releasing it after
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.
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
The moral equivalent of if (p) exp when p has side-effects
The moral equivalent of if (p) exp when p has side-effects
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.
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.
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.
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.
Deprecated methods
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.
- Deprecated