IO3

izumi.functional.bio.IO3
trait IO3[F[_, _, _]] extends Panic3[F]

Attributes

Graph
Supertypes
trait Panic3[F]
trait Bracket3[F]
trait Error3[F]
trait Monad3[F]
trait Bifunctor3[F]
trait Guarantee3[F]
trait Applicative3[F]
trait Functor3[F]
trait RootBifunctor[F]
trait Root
class Object
trait Matchable
class Any
Known subtypes
trait Async3[F]
class AsyncZio
object AsyncZio.type

Members list

Concise view

Type members

Types

final type Just[+A] = F[Any, Nothing, A]
final type Or[+E, +A] = F[Any, E, A]

Inherited types

Attributes

Inherited from:
DivergenceHelper

Attributes

Inherited from:
PredefinedHelper

Value members

Abstract methods

def sync[A](effect: => A): F[Any, Nothing, A]

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

sync means synchronous, that is, a blocking CPU effect, as opposed to a non-blocking asynchronous effect or a long blocking I/O effect (izumi.functional.bio.BlockingIO3#syncBlocking)

Example:
import izumi.functional.bio.F
val referentiallyTransparentArrayAllocation: F[Nothing, Array[Byte]] = {
 F.sync(new Array(256))
}
def syncThrowable[A](effect: => A): F[Any, Throwable, A]

Capture a side-effectful block of code that can throw exceptions

Capture a side-effectful block of code that can throw exceptions

Attributes

Note:

sync means synchronous, that is, a blocking CPU effect, as opposed to a non-blocking asynchronous effect or a long blocking I/O effect (izumi.functional.bio.BlockingIO3#syncBlocking)

Concrete methods

final def apply[A](effect: => A): F[Any, Throwable, A]
override def fromEither[E, A](effect: => Either[E, A]): F[Any, E, A]

Attributes

Definition Classes
override def fromOption[E, A](errorOnNone: => E)(effect: => Option[A]): F[Any, E, A]

Attributes

Definition Classes
override def fromTry[A](effect: => Try[A]): F[Any, Throwable, A]

Attributes

Definition Classes
def suspend[R, A](effect: => F[R, Throwable, A]): F[R, Throwable, A]

Inherited methods

override def *>[R, E, A, B](f: F[R, E, A], next: => F[R, E, B]): F[R, E, B]

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:
Monad3
override def <*[R, E, A, B](f: F[R, E, A], next: => F[R, E, B]): F[R, E, A]

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:
Monad3
override def InnerF: Functor3[F]

Attributes

Definition Classes
Inherited from:
ApplicativeError3
def as[R, E, A, B](r: F[R, E, A])(v: => B): F[R, E, B]

Attributes

Inherited from:
Functor3
def attempt[R, E, A](r: F[R, E, A]): F[R, Nothing, Either[E, A]]

Attributes

Inherited from:
Error3
override def bimap[R, E, A, E2, B](r: F[R, E, A])(f: E => E2, g: A => B): F[R, E2, B]

Attributes

Definition Classes
Inherited from:
Error3
def bracket[R, E, A, B](acquire: F[R, E, A])(release: A => F[R, Nothing, Unit])(use: A => F[R, E, B]): F[R, E, B]

Attributes

Inherited from:
Bracket3
def bracketCase[R, E, A, B](acquire: F[R, E, A])(release: (A, Exit[E, B]) => F[R, Nothing, Unit])(use: A => F[R, E, B]): F[R, E, B]

Attributes

Inherited from:
Bracket3
def bracketExcept[R, E, A, B](acquire: RestoreInterruption3[F] => F[R, E, A])(release: (A, Exit[E, B]) => F[R, Nothing, Unit])(use: A => F[R, E, B]): F[R, E, B]

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

Inherited from:
Panic3
final def bracketOnFailure[R, E, A, B](acquire: F[R, E, A])(cleanupOnFailure: (A, Failure[E]) => F[R, Nothing, Unit])(use: A => F[R, E, B]): F[R, E, B]

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:
Bracket3
def catchAll[R, E, A, E2](r: F[R, E, A])(f: E => F[R, E2, A]): F[R, E2, A]

Attributes

Inherited from:
Error3
def catchSome[R, E, A, E1 >: E](r: F[R, E, A])(f: PartialFunction[E, F[R, E1, A]]): F[R, E1, A]

Attributes

Inherited from:
Error3
def fail[E](v: => E): F[Any, E, Nothing]

Attributes

Inherited from:
ApplicativeError3
def flatMap[R, E, A, B](r: F[R, E, A])(f: A => F[R, E, B]): F[R, E, B]

Attributes

Inherited from:
Monad3
def flatten[R, E, A](r: F[R, E, F[R, E, A]]): F[R, E, A]

Attributes

Inherited from:
Monad3
def flip[R, E, A](r: F[R, E, A]): F[R, A, E]

Attributes

Inherited from:
Error3
final def forever[R, E, A](r: F[R, E, A]): F[R, E, Nothing]

Attributes

Inherited from:
Applicative3
def fromOption[R, E, A](errorOnNone: => E, r: F[R, E, Option[A]]): F[R, E, A]

Extracts the optional value or fails with the errorOnNone error

Extracts the optional value or fails with the errorOnNone error

Attributes

Inherited from:
Error3
def fromOptionF[R, E, A](fallbackOnNone: => F[R, E, A], r: F[R, E, Option[A]]): F[R, E, A]

Extracts the optional value, or executes the fallbackOnNone effect

Extracts the optional value, or executes the fallbackOnNone effect

Attributes

Inherited from:
Monad3
def fromOptionOr[R, E, A](valueOnNone: => A, r: F[R, E, Option[A]]): F[R, E, A]

Extracts the optional value, or returns the given valueOnNone value

Extracts the optional value, or returns the given valueOnNone value

Attributes

Inherited from:
Functor3
override def guarantee[R, E, A](f: F[R, E, A], cleanup: F[R, Nothing, Unit]): F[R, E, A]

Attributes

Definition Classes
Inherited from:
Bracket3
def guaranteeCase[R, E, A](f: F[R, E, A], cleanup: Exit[E, A] => F[R, Nothing, Unit]): F[R, E, A]

Attributes

Inherited from:
Bracket3
final def guaranteeExceptOnInterrupt[R, E, A](f: F[R, E, A], cleanupOnNonInterruption: Either[Termination, Either[Error[E], Success[A]]] => F[R, Nothing, Unit]): F[R, E, A]

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:
Bracket3
final def guaranteeOnFailure[R, E, A](f: F[R, E, A], cleanupOnFailure: Failure[E] => F[R, Nothing, Unit]): F[R, E, A]

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:
Bracket3
final def guaranteeOnInterrupt[R, E, A](f: F[R, E, A], cleanupOnInterruption: Interruption => F[R, Nothing, Unit]): F[R, E, A]

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:
Bracket3
final def ifThenElse[R, E, E1, A](cond: F[R, E, Boolean])(ifTrue: => F[R, E1, A], ifFalse: => F[R, E1, A])(implicit ev: E <:< E1): F[R, E1, A]

Attributes

Inherited from:
Monad3
final def ifThenElse[R, E, A](cond: Boolean)(ifTrue: => F[R, E, A], ifFalse: => F[R, E, A]): F[R, E, A]

Attributes

Inherited from:
Applicative3
def iterateUntil[R, E, A](r: F[R, E, A])(p: A => Boolean): F[R, E, A]

Execute an action repeatedly until its result satisfies the given predicate and return that result, discarding all others.

Execute an action repeatedly until its result satisfies the given predicate and return that result, discarding all others.

Attributes

Inherited from:
Monad3
def iterateUntilF[R, E, A](init: A)(f: A => F[R, E, A])(p: A => Boolean): F[R, E, A]

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:
Monad3
def iterateWhile[R, E, A](r: F[R, E, A])(p: A => Boolean): F[R, E, A]

Execute an action repeatedly until its result fails to satisfy the given predicate and return that result, discarding all others.

Execute an action repeatedly until its result fails to satisfy the given predicate and return that result, discarding all others.

Attributes

Inherited from:
Monad3
def iterateWhileF[R, E, A](init: A)(f: A => F[R, E, A])(p: A => Boolean): F[R, E, A]

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:
Monad3
def leftFlatMap[R, E, A, E2](r: F[R, E, A])(f: E => F[R, Nothing, E2]): F[R, E2, A]

Attributes

Inherited from:
Error3
def leftMap[R, E, A, E2](r: F[R, E, A])(f: E => E2): F[R, E2, A]

Attributes

Inherited from:
Bifunctor3
override def leftMap2[R, E, A, E2, E3](firstOp: F[R, E, A], secondOp: => F[R, E2, A])(f: (E, E2) => E3): F[R, E3, A]

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:
Error3
override def map[R, E, A, B](r: F[R, E, A])(f: A => B): F[R, E, B]

Attributes

Definition Classes
Inherited from:
Monad3
override def map2[R, E, A, B, C](r1: F[R, E, A], r2: => F[R, E, B])(f: (A, B) => C): F[R, E, C]

execute two operations in order, map their results

execute two operations in order, map their results

Attributes

Definition Classes
Inherited from:
Monad3
override def orElse[R, E, A, E2](r: F[R, E, A], f: => F[R, E2, A]): F[R, E2, A]

execute second operation only if the first one fails

execute second operation only if the first one fails

Attributes

Definition Classes
Inherited from:
Error3
final def orTerminate[R, A](r: F[R, Throwable, A]): F[R, Nothing, A]

Attributes

Inherited from:
Panic3
def pure[A](a: A): F[Any, Nothing, A]

Attributes

Inherited from:
Applicative3
def redeem[R, E, A, E2, B](r: F[R, E, A])(err: E => F[R, E2, B], succ: A => F[R, E2, B]): F[R, E2, B]

Attributes

Inherited from:
Error3
def redeemPure[R, E, A, B](r: F[R, E, A])(err: E => B, succ: A => B): F[R, Nothing, B]

Attributes

Inherited from:
Error3
def retryUntil[R, E, A](r: F[R, E, A])(f: E => Boolean): F[R, E, A]

Retries this effect until its error satisfies the specified predicate.

Retries this effect until its error satisfies the specified predicate.

Attributes

Inherited from:
Error3
def retryUntilF[R, R1 <: R, E, A](r: F[R, E, A])(f: E => F[R1, Nothing, Boolean]): F[R1, E, A]

Retries this effect until its error satisfies the specified effectful predicate.

Retries this effect until its error satisfies the specified effectful predicate.

Attributes

Inherited from:
Error3
def retryWhile[R, E, A](r: F[R, E, A])(f: E => Boolean): F[R, E, A]

Retries this effect while its error satisfies the specified predicate.

Retries this effect while its error satisfies the specified predicate.

Attributes

Inherited from:
Error3
def retryWhileF[R, R1 <: R, E, A](r: F[R, E, A])(f: E => F[R1, Nothing, Boolean]): F[R1, E, A]

Retries this effect while its error satisfies the specified effectful predicate.

Retries this effect while its error satisfies the specified effectful predicate.

Attributes

Inherited from:
Error3
def sandbox[R, E, A](r: F[R, E, A]): F[R, Failure[E], A]

Attributes

Note:

Will return either Exit.Error or Exit.Termination in the error channel. Exit.Interruption cannot be sandboxed. Use guaranteeOnInterrupt for cleanups on interruptions.

Inherited from:
Panic3
final def sandboxExit[R, E, A](r: F[R, E, A]): F[R, Nothing, Exit[E, A]]

Attributes

Note:

Will return either Exit.Error or Exit.Termination. Exit.Interruption cannot be sandboxed. Use guaranteeOnInterrupt for cleanups on interruptions.

Inherited from:
Panic3
def sendInterruptToSelf: F[Any, Nothing, Unit]

Signal interruption to this fiber.

Signal interruption to this fiber.

This is NOT the same as

 F.halt(Exit.Interrupted(Trace.empty))

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.empty)) *>
   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:
Inherited from:
Panic3
def sequence[R, E, A](l: Iterable[F[R, E, A]]): F[R, E, List[A]]

Attributes

Inherited from:
Applicative3
def sequence_[R, E](l: Iterable[F[R, E, Unit]]): F[R, E, Unit]

Attributes

Inherited from:
Applicative3
def tailRecM[R, E, A, B](a: A)(f: A => F[R, E, Either[A, B]]): F[R, E, B]

Attributes

Inherited from:
Monad3
def tap[R, E, A](r: F[R, E, A], f: A => F[R, E, Unit]): F[R, E, A]

Attributes

Inherited from:
Monad3
def tapBoth[R, E, A, E1 >: E](r: F[R, E, A])(err: E => F[R, E1, Unit], succ: A => F[R, E1, Unit]): F[R, E1, A]

Attributes

Inherited from:
Error3
def tapError[R, E, A, E1 >: E](r: F[R, E, A])(f: E => F[R, E1, Unit]): F[R, E1, A]

Attributes

Inherited from:
Error3
def terminate(v: => Throwable): F[Any, Nothing, Nothing]

Attributes

Inherited from:
Panic3
final def traverse[R, E, A, B](o: Option[A])(f: A => F[R, E, B]): F[R, E, Option[B]]

Attributes

Inherited from:
Applicative3
def traverse[R, E, A, B](l: Iterable[A])(f: A => F[R, E, B]): F[R, E, List[B]]

Attributes

Inherited from:
Applicative3
def traverse_[R, E, A](l: Iterable[A])(f: A => F[R, E, Unit]): F[R, E, Unit]

Attributes

Inherited from:
Applicative3
def uninterruptible[R, E, A](r: F[R, E, A]): F[R, E, A]

Attributes

Inherited from:
Panic3
def uninterruptibleExcept[R, E, A](r: RestoreInterruption3[F] => F[R, E, A]): F[R, E, A]

Designate the effect uninterruptible, with exception of regions in it that are specifically marked to restore previous interruptibility status using the provided RestoreInterruption function

Designate the effect uninterruptible, with 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 RestoreInterruption will have no effect. e.g. the expression F.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
 }
Inherited from:
Panic3
def unit: F[Any, Nothing, Unit]

Attributes

Inherited from:
Applicative3
final def unless[R, E, E1](cond: F[R, E, Boolean])(ifFalse: => F[R, E1, Unit])(implicit ev: E <:< E1): F[R, E1, Unit]

Attributes

Inherited from:
Monad3
final def unless[R, E](cond: Boolean)(ifFalse: => F[R, E, Unit]): F[R, E, Unit]

Attributes

Inherited from:
Applicative3
def void[R, E, A](r: F[R, E, A]): F[R, E, Unit]

Attributes

Inherited from:
Functor3
final def when[R, E, E1](cond: F[R, E, Boolean])(ifTrue: => F[R, E1, Unit])(implicit ev: E <:< E1): F[R, E1, Unit]

Attributes

Inherited from:
Monad3
final def when[R, E](cond: Boolean)(ifTrue: => F[R, E, Unit]): F[R, E, Unit]

Attributes

Inherited from:
Applicative3
final def widen[R, E, A, A1](r: F[R, E, A])(implicit ev: A <:< A1): F[R, E, A1]

Attributes

Inherited from:
Functor3
final def widenBoth[R, E, A, E1, A1](r: F[R, E, A])(implicit ev: E <:< E1, ev2: A <:< A1): F[R, E1, A1]

Attributes

Inherited from:
Bifunctor3
final def widenError[R, E, A, E1](r: F[R, E, A])(implicit ev: E <:< E1): F[R, E1, A]

Attributes

Inherited from:
Bifunctor3
final def withFilter[R, E, A](r: F[R, E, A])(predicate: A => Boolean)(implicit filter: WithFilter[E], pos: SourceFilePositionMaterializer): F[R, E, A]

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:
Error3