Attributes
- Companion
- object
- Graph
-
- Supertypes
-
class AsyncZio[R]trait Roottrait PredefinedHelpertrait DivergenceHelperclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
object TemporalZio
Members list
Type members
Inherited types
Attributes
- Inherited from:
- DivergenceHelper
Attributes
- Inherited from:
- PredefinedHelper
Value members
Concrete methods
Attributes
- Definition Classes
Inherited methods
execute two operations in order, return result of second operation
execute two operations in order, return result of second operation
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
execute two operations in order, same as *>, but return result of first operation
execute two operations in order, same as *>, but return result of first operation
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Definition Classes
-
AsyncZio -> Async2 -> WeakAsync2 -> ApplicativeError2 -> Bifunctor2 -> Concurrent2 -> ParallelErrorAccumulatingOps2 -> Parallel2
- Inherited from:
- AsyncZio
Attributes
- Definition Classes
- Inherited from:
- IO2
Attributes
- Inherited from:
- IO2
Construct an effect from an asynchronous callback-based API.
Construct an effect from an asynchronous callback-based API.
The callback provided to register must be invoked exactly once with either a success value wrapped in Right or an error wrapped in Left.
Example:
def readFile[F[+_, +_]: WeakAsync2](path: String): F[Throwable, String] = {
F.async { cb =>
asyncFileReader.read(path)(
onSuccess = content => cb(Right(content)),
onError = err => cb(Left(err))
)
}
}
Attributes
- Note
-
Effects created with async, asyncF, asyncWithOnInterrupt, fromFuture and fromFutureJava are INTERRUPTIBLE. - In case of async and asyncF if the current fiber is interrupted, the registered callback will be simply THROWN AWAY. - If a cleanup action is required to wind down the async operation safely, use asyncWithOnInterrupt to provide a cleanup action. - If an async operation's callback CANNOT be safely discarded OR interrupted, wrap your expression in Panic2.uninterruptible.
to implementors: The effect produced MUST be interruptible.
- Definition Classes
- Inherited from:
- AsyncZio
Same as async, but registration action can use F capabilities. Registration action itself is uninterruptible, but the produced effect is interruptible.
Same as async, but registration action can use F capabilities. Registration action itself is uninterruptible, but the produced effect is interruptible.
Attributes
- Note
-
Effects created with async, asyncF, asyncWithOnInterrupt, fromFuture and fromFutureJava are INTERRUPTIBLE. - In case of async and asyncF if the current fiber is interrupted, the registered callback will be simply THROWN AWAY. - If a cleanup action is required to wind down the async operation safely, use asyncWithOnInterrupt to provide a cleanup action. - If an async operation's callback CANNOT be safely discarded OR interrupted, wrap your expression in Panic2.uninterruptible.
to implementors: The effect produced MUST be interruptible.
- Definition Classes
- Inherited from:
- AsyncZio
Just as in async, registers async callback impurely, but also returns an F effect that will be executed to interrupt the async action if the current fiber is interrupted
Just as in async, registers async callback impurely, but also returns an F effect that will be executed to interrupt the async action if the current fiber is interrupted
Attributes
- Note
-
Effects created with async, asyncF, asyncWithOnInterrupt, fromFuture and fromFutureJava are INTERRUPTIBLE. - In case of async and asyncF if the current fiber is interrupted, the registered callback will be simply THROWN AWAY. - If a cleanup action is required to wind down the async operation safely, use asyncWithOnInterrupt to provide a cleanup action. - If an async operation's callback CANNOT be safely discarded OR interrupted, wrap your expression in Panic2.uninterruptible.
to implementors: The effect produced MUST be interruptible.
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Like bracketCase, but acquire can contain marked interruptible regions as in uninterruptibleExcept
Like bracketCase, but acquire can contain marked interruptible regions as in uninterruptibleExcept
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Run release action only on a failure – any failure, INCLUDING interruption. Do not run release action if use finished successfully.
Run release action only on a failure – any failure, INCLUDING interruption. Do not run release action if use finished successfully.
Attributes
- Inherited from:
- Bracket2
Attributes
- Inherited from:
- Applicative2
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Inherited from:
- Applicative2
flatSequence with error accumulation
Attributes
- Inherited from:
- Applicative2
flatTraverse with error accumulation
Attributes
- Inherited from:
- Applicative2
For lazy monads: alias for IO2#syncThrowable. For strict monads, shorthand for F.fromTry(Try(effect))
For lazy monads: alias for IO2#syncThrowable. For strict monads, shorthand for F.fromTry(Try(effect))
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Note
-
to implementors: The effect produced MUST be interruptible (cats.effect.IO's fromFuture is not!)
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Inherited from:
- WeakAsync2
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Extracts the optional value or fails with the errorOnNone error
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Run cleanup on both success and failure, if the failure IS NOT an interruption.
Run cleanup on both success and failure, if the failure IS NOT an interruption.
Attributes
- Inherited from:
- Bracket2
Run cleanup only on a failure – any failure, INCLUDING interruption. Do not run cleanup if use finished successfully.
Run cleanup only on a failure – any failure, INCLUDING interruption. Do not run cleanup if use finished successfully.
Attributes
- Inherited from:
- Bracket2
Run cleanup only on interruption. Do not run cleanup if use finished successfully.
Run cleanup only on interruption. Do not run cleanup if use finished successfully.
Attributes
- Inherited from:
- Bracket2
Attributes
- Inherited from:
- Monad2
Attributes
- Inherited from:
- Applicative2
Attributes
- Inherited from:
- ApplicativeError2
Execute an action repeatedly until its result satisfies the given predicate and return that result, discarding all others.
Apply an effectful function iteratively until its result satisfies the given predicate and return that result.
Apply an effectful function iteratively until its result satisfies the given predicate and return that result.
Attributes
- Inherited from:
- Monad2
Execute an action repeatedly until its result fails to satisfy the given predicate and return that result, discarding all others.
Apply an effectful function iteratively until its result fails to satisfy the given predicate and return that result.
Apply an effectful function iteratively until its result fails to satisfy the given predicate and return that result.
Attributes
- Inherited from:
- Monad2
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
map errors from two operations into a new error if both fail
map errors from two operations into a new error if both fail
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
execute two operations in order, map their results
execute two operations in order, map their results
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
execute second operation only if the first one fails
execute second operation only if the first one fails
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Inherited from:
- Panic2
Attributes
- Inherited from:
- Panic2
Attributes
- Inherited from:
- ParallelErrorAccumulatingOps2
Attributes
- Inherited from:
- ParallelErrorAccumulatingOps2
parTraverseN with maxConcurrent set to the number of cores, or 2 when on single-core processor
parTraverseN with maxConcurrent set to the number of cores, or 2 when on single-core processor
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Inherited from:
- Error2
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Race two actions, the winner is the first action to TERMINATE, whether by success or failure
Race two actions, the winner is the first action to TERMINATE, whether by success or failure
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Race two actions, the winner is the first action to TERMINATE, whether by success or failure
Attributes
- Inherited from:
- WeakTemporal2
Attributes
- Note
-
Will return either Exit.Success, Exit.Error or Exit.Termination. Exit.Interruption cannot be sandboxed – use guaranteeOnInterrupt for cleanups on interruptions.
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Inherited from:
- Panic2
Attributes
- Note
-
Will return either Exit.Success, Exit.Error or Exit.Termination. Exit.Interruption cannot be sandboxed. Use guaranteeOnInterrupt for cleanups on interruptions.
- Inherited from:
- Panic2
Signal interruption to this fiber.
Signal interruption to this fiber.
This is NOT the same as
F.halt(Exit.Interrupted(Trace.forUnknownError))
The code above exits with Exit.Interrupted failure unconditionally, whereas sendInterruptToSelf will not exit when in an uninterruptible region. Example:
F.uninterruptible {
F.halt(Exit.Interrupted(Trace.forUnknownError)) *>
F.sync(println("Hello!")) // interrupted above. Hello _not_ printed
}
But with sendInterruptToSelf:
F.uninterruptible {
F.sendInterruptToSelf *>
F.sync(println("Hello!")) // Hello IS printed.
} *> F.sync(println("Impossible")) // interrupted immediately after `uninterruptible` block ends. Impossible _not_ printed
Attributes
- See also
-
- https://github.com/zio/interop-cats/issues/503 - History of supporting this method in ZIO
- https://github.com/zio/zio/issues/6911 - related issue
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
sequence with error accumulation
sequence with error accumulation
sequence_ with error accumulation
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Capture an exception-safe side-effect such as memory mutation or randomness
Capture an exception-safe side-effect such as memory mutation or randomness
Attributes
- Note
-
If you're not completely sure that a captured block can't throw, use syncThrowable
syncmeanssynchronous, that is, a blocking CPU effect, as opposed to a non-blocking asynchronous effect or a long blocking I/O effect (izumi.functional.bio.BlockingIO2#syncBlocking) - Example
-
import izumi.functional.bio.F val exceptionSafeArrayAllocation: F[Nothing, Array[Byte]] = { F.sync(new Array(256)) } - Definition Classes
- Inherited from:
- AsyncZio
Capture a side-effectful block of code that can throw exceptions
Capture a side-effectful block of code that can throw exceptions
Attributes
- Note
-
syncmeanssynchronous, that is, a blocking CPU effect, as opposed to a non-blocking asynchronous effect or a long blocking I/O effect (izumi.functional.bio.BlockingIO2#syncBlocking) - Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Inherited from:
- Monad2
Attributes
- Inherited from:
- Temporal2
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Inherited from:
- Applicative2
traverse with error accumulation
traverse with error accumulation
traverse_ with error accumulation
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Designate the effect uninterruptible, with the exception of regions in it that are specifically marked to restore previous interruptibility status using the provided RestoreInterruption function
Designate the effect uninterruptible, with the exception of regions in it that are specifically marked to restore previous interruptibility status using the provided RestoreInterruption function
Attributes
- Note
-
Interruptibility status will be restored to what it was in the outer region, so if the outer region was also uninterruptible, the provided
RestoreInterruptionwill have no effect. e.g. the expressionF.uninterruptible { F.uninterruptibleExcept { restore => restore(F.sleep(1.second)) }is fully uninterruptible throughout - Example
-
F.uninterruptibleExcept { restoreInterruption => val workLoop = { importantWorkThatMustNotBeInterrupted() *> log.info("Taking a break for a second, you can interrupt me while I wait!") *> restoreInterruption.apply { F.sleep(1.second) .guaranteeOnInterrupt(_ => log.info("Got interrupted!")) } *> log.info("No interruptions, going back to work!") *> workLoop } workLoop } - Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Inherited from:
- Monad2
Attributes
- Inherited from:
- Applicative2
Attributes
- Inherited from:
- Monad2
Attributes
- Inherited from:
- Applicative2
Attributes
- Inherited from:
- Functor2
Attributes
- Inherited from:
- Bifunctor2
Attributes
- Inherited from:
- Bifunctor2
for-comprehensions sugar:
for-comprehensions sugar:
for {
(1, 2) <- F.pure((2, 1))
} yield ()
Use widenError to for pattern matching with non-Throwable errors:
val f = for {
(1, 2) <- F.pure((2, 1)).widenError[Option[Unit]]
} yield ()
// f: F[Option[Unit], Unit] = F.fail(Some(())
Attributes
- Inherited from:
- Error2
Attributes
- Definition Classes
- Inherited from:
- AsyncZio
Attributes
- Inherited from:
- Applicative2
Returns an effect that executes both effects, in parallel, combining their results into a tuple. If either side fails, then the other side will be interrupted.
Returns an effect that executes both effects, in parallel, the left effect result is returned. If either side fails, then the other side will be interrupted.
Returns an effect that executes both effects, in parallel, the right effect result is returned. If either side fails, then the other side will be interrupted.
Returns an effect that executes both effects, in parallel, combining their results with the specified f function. If either side fails, then the other side will be interrupted.
Deprecated and Inherited methods
Attributes
- Deprecated
-
[Since version 1.3]renamed to asyncWithOnInterrupt - Inherited from:
- Async2