Packages

trait Bracket3[F[-_, +_, +_]] extends Error3[F]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bracket3
  2. Error3
  3. ErrorAccumulatingOps3
  4. Monad3
  5. ApplicativeError3
  6. Bifunctor3
  7. Guarantee3
  8. Applicative3
  9. Functor3
  10. RootBifunctor
  11. Root
  12. PredefinedHelper
  13. DivergenceHelper
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Divergence = Nondivergent
    Definition Classes
    DivergenceHelper
  2. type IsPredefined = NotPredefined
    Definition Classes
    PredefinedHelper

Abstract Value Members

  1. abstract 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]
  2. abstract def catchAll[R, E, A, E2](r: F[R, E, A])(f: (E) => F[R, E2, A]): F[R, E2, A]
    Definition Classes
    Error3
  3. abstract def fail[E](v: => E): F[Any, E, Nothing]
    Definition Classes
    ApplicativeError3
  4. abstract def flatMap[R, E, A, B](r: F[R, E, A])(f: (A) => F[R, E, B]): F[R, E, B]
    Definition Classes
    Monad3
  5. abstract def fromEither[E, V](effect: => Either[E, V]): F[Any, E, V]
    Definition Classes
    ApplicativeError3
  6. abstract def fromOption[E, A](errorOnNone: => E)(effect: => Option[A]): F[Any, E, A]
    Definition Classes
    ApplicativeError3
  7. abstract def fromTry[A](effect: => Try[A]): F[Any, Throwable, A]
    Definition Classes
    ApplicativeError3
  8. abstract def pure[A](a: A): F[Any, Nothing, A]
    Definition Classes
    Applicative3

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. 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

    Definition Classes
    Monad3 → Applicative3
  4. 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

    Definition Classes
    Monad3 → Applicative3
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def InnerF: Functor3[F]
    Definition Classes
    ApplicativeError3 → Bifunctor3
  7. def accumulateErrorsImpl[ColL[_], ColR[x] <: IterableOnce[x], R, E, E1, A, B, B1, AC](col: ColR[A])(effect: (A) => F[R, E, B], onLeft: (E) => IterableOnce[E1], init: AC, onRight: (AC, B) => AC, end: (AC) => B1)(implicit buildL: Factory[E1, ColL[E1]]): F[R, ColL[E1], B1]
    Attributes
    protected[this]
    Definition Classes
    ErrorAccumulatingOps3
  8. def as[R, E, A, B](r: F[R, E, A])(v: => B): F[R, E, B]
    Definition Classes
    Functor3
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def attempt[R, E, A](r: F[R, E, A]): F[R, Nothing, Either[E, A]]
    Definition Classes
    Error3
  11. def bimap[R, E, A, E2, B](r: F[R, E, A])(f: (E) => E2, g: (A) => B): F[R, E2, B]
    Definition Classes
    Error3 → Bifunctor3
  12. 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]
  13. 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.

    Run release action only on a failure – _any failure_, INCLUDING interruption. Do not run release action if use finished successfully.

  14. def catchSome[R, E, A, E1 >: E](r: F[R, E, A])(f: PartialFunction[E, F[R, E1, A]]): F[R, E1, A]
    Definition Classes
    Error3
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. def collect[R, E, A, B](l: Iterable[A])(f: (A) => F[R, E, Option[B]]): F[R, E, List[B]]
    Definition Classes
    Applicative3
  17. def collectFirst[R, E, A, B](l: Iterable[A])(f: (A) => F[R, E, Option[B]]): F[R, E, Option[B]]
    Definition Classes
    Monad3
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. def filter[R, E, A](l: Iterable[A])(f: (A) => F[R, E, Boolean]): F[R, E, List[A]]
    Definition Classes
    Applicative3
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  22. def find[R, E, A](l: Iterable[A])(f: (A) => F[R, E, Boolean]): F[R, E, Option[A]]
    Definition Classes
    Monad3
  23. def flatSequence[R, E, A](l: Iterable[F[R, E, Iterable[A]]]): F[R, E, List[A]]
    Definition Classes
    Applicative3
  24. def flatSequenceAccumErrors[ColR[x] <: IterableOnce[x], ColIn[x] <: IterableOnce[x], ColL[_], R, E, A](col: ColR[F[R, ColL[E], ColIn[A]]])(implicit buildR: Factory[A, ColR[A]], buildL: Factory[E, ColL[E]], iterL: (ColL[E]) => IterableOnce[E]): F[R, ColL[E], ColR[A]]

    flatSequence with error accumulation

    flatSequence with error accumulation

    Definition Classes
    ErrorAccumulatingOps3
  25. def flatTraverse[R, E, A, B](l: Iterable[A])(f: (A) => F[R, E, Iterable[B]]): F[R, E, List[B]]
    Definition Classes
    Applicative3
  26. def flatTraverseAccumErrors[ColR[x] <: IterableOnce[x], ColIn[x] <: IterableOnce[x], ColL[_], R, E, A, B](col: ColR[A])(f: (A) => F[R, ColL[E], ColIn[B]])(implicit buildR: Factory[B, ColR[B]], buildL: Factory[E, ColL[E]], iterL: (ColL[E]) => IterableOnce[E]): F[R, ColL[E], ColR[B]]

    flatTraverse with error accumulation

    flatTraverse with error accumulation

    Definition Classes
    ErrorAccumulatingOps3
  27. def flatten[R, E, A](r: F[R, E, F[R, E, A]]): F[R, E, A]
    Definition Classes
    Monad3
  28. def flip[R, E, A](r: F[R, E, A]): F[R, A, E]
    Definition Classes
    Error3
  29. def foldLeft[R, E, A, AC](l: Iterable[A])(z: AC)(f: (AC, A) => F[R, E, AC]): F[R, E, AC]
    Definition Classes
    Monad3
  30. final def forever[R, E, A](r: F[R, E, A]): F[R, E, Nothing]
    Definition Classes
    Applicative3
    Annotations
    @inline()
  31. 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

    Definition Classes
    Error3
  32. 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

    Definition Classes
    Monad3
  33. 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

    Definition Classes
    Functor3
  34. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. def guarantee[R, E, A](f: F[R, E, A], cleanup: F[R, Nothing, Unit]): F[R, E, A]
    Definition Classes
    Bracket3 → Guarantee3
  36. def guaranteeCase[R, E, A](f: F[R, E, A], cleanup: (Exit[E, A]) => F[R, Nothing, Unit]): F[R, E, A]
  37. 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.

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

    Run cleanup only on a failure – _any failure_, INCLUDING interruption. Do not run cleanup if use finished successfully.

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

    Run cleanup only on interruption. Do not run cleanup if use finished successfully.

  40. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. 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]
    Definition Classes
    Monad3
    Annotations
    @inline()
  42. final def ifThenElse[R, E, A](cond: Boolean)(ifTrue: => F[R, E, A], ifFalse: => F[R, E, A]): F[R, E, A]
    Definition Classes
    Applicative3
    Annotations
    @inline()
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. 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.

    Definition Classes
    Monad3
  45. 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.

    Definition Classes
    Monad3
  46. 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.

    Definition Classes
    Monad3
  47. 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.

    Definition Classes
    Monad3
  48. def leftFlatMap[R, E, A, E2](r: F[R, E, A])(f: (E) => F[R, Nothing, E2]): F[R, E2, A]
    Definition Classes
    Error3
  49. def leftMap[R, E, A, E2](r: F[R, E, A])(f: (E) => E2): F[R, E2, A]
    Definition Classes
    Bifunctor3
  50. 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

    Definition Classes
    Error3 → ApplicativeError3
  51. def map[R, E, A, B](r: F[R, E, A])(f: (A) => B): F[R, E, B]
    Definition Classes
    Monad3 → Functor3
  52. 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

    Definition Classes
    Monad3 → Applicative3
  53. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  55. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  56. 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

    Definition Classes
    Error3 → ApplicativeError3
  57. def partition[R, E, A](l: Iterable[F[R, E, A]]): F[R, Nothing, (List[E], List[A])]
    Definition Classes
    Error3
    Annotations
    @nowarn()
  58. 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]
    Definition Classes
    Error3
  59. def redeemPure[R, E, A, B](r: F[R, E, A])(err: (E) => B, succ: (A) => B): F[R, Nothing, B]
    Definition Classes
    Error3
  60. 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.

    Definition Classes
    Error3
  61. 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.

    Definition Classes
    Error3
  62. 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.

    Definition Classes
    Error3
  63. 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.

    Definition Classes
    Error3
  64. def sequence[R, E, A](l: Iterable[F[R, E, A]]): F[R, E, List[A]]
    Definition Classes
    Applicative3
  65. def sequenceAccumErrors[ColR[x] <: IterableOnce[x], ColL[_], R, E, A](col: ColR[F[R, ColL[E], A]])(implicit buildR: Factory[A, ColR[A]], buildL: Factory[E, ColL[E]], iterL: (ColL[E]) => IterableOnce[E]): F[R, ColL[E], ColR[A]]

    sequence with error accumulation

    sequence with error accumulation

    Definition Classes
    ErrorAccumulatingOps3
  66. def sequenceAccumErrorsNEList[ColR[x] <: IterableOnce[x], R, E, A](col: ColR[F[R, E, A]])(implicit buildR: Factory[A, ColR[A]]): F[R, NEList[E], ColR[A]]

    sequence with error accumulation

    sequence with error accumulation

    Definition Classes
    ErrorAccumulatingOps3
  67. def sequenceAccumErrors_[ColR[x] <: IterableOnce[x], ColL[_], R, E, A](col: ColR[F[R, ColL[E], A]])(implicit buildL: Factory[E, ColL[E]], iterL: (ColL[E]) => IterableOnce[E]): F[R, ColL[E], Unit]

    sequence_ with error accumulation

    sequence_ with error accumulation

    Definition Classes
    ErrorAccumulatingOps3
  68. def sequence_[R, E](l: Iterable[F[R, E, Unit]]): F[R, E, Unit]
    Definition Classes
    Applicative3
  69. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  70. def tailRecM[R, E, A, B](a: A)(f: (A) => F[R, E, Either[A, B]]): F[R, E, B]
    Definition Classes
    Monad3
  71. def tap[R, E, A](r: F[R, E, A], f: (A) => F[R, E, Unit]): F[R, E, A]
    Definition Classes
    Monad3
  72. 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]
    Definition Classes
    Error3
  73. def tapError[R, E, A, E1 >: E](r: F[R, E, A])(f: (E) => F[R, E1, Unit]): F[R, E1, A]
    Definition Classes
    Error3
  74. def toString(): String
    Definition Classes
    AnyRef → Any
  75. final def traverse[R, E, A, B](o: Option[A])(f: (A) => F[R, E, B]): F[R, E, Option[B]]
    Definition Classes
    Applicative3
    Annotations
    @inline()
  76. def traverse[R, E, A, B](l: Iterable[A])(f: (A) => F[R, E, B]): F[R, E, List[B]]
    Definition Classes
    Applicative3
  77. def traverseAccumErrors[ColR[x] <: IterableOnce[x], ColL[_], R, E, A, B](col: ColR[A])(f: (A) => F[R, ColL[E], B])(implicit buildR: Factory[B, ColR[B]], buildL: Factory[E, ColL[E]], iterL: (ColL[E]) => IterableOnce[E]): F[R, ColL[E], ColR[B]]

    traverse with error accumulation

    traverse with error accumulation

    Definition Classes
    ErrorAccumulatingOps3
  78. def traverseAccumErrors_[ColR[x] <: IterableOnce[x], ColL[_], R, E, A](col: ColR[A])(f: (A) => F[R, ColL[E], Unit])(implicit buildL: Factory[E, ColL[E]], iterL: (ColL[E]) => IterableOnce[E]): F[R, ColL[E], Unit]

    traverse_ with error accumulation

    traverse_ with error accumulation

    Definition Classes
    ErrorAccumulatingOps3
  79. def traverse_[R, E, A](l: Iterable[A])(f: (A) => F[R, E, Unit]): F[R, E, Unit]
    Definition Classes
    Applicative3
  80. def unit: F[Any, Nothing, Unit]
    Definition Classes
    Applicative3
  81. final def unless[R, E, E1](cond: F[R, E, Boolean])(ifFalse: => F[R, E1, Unit])(implicit ev: <:<[E, E1]): F[R, E1, Unit]
    Definition Classes
    Monad3
    Annotations
    @inline()
  82. final def unless[R, E](cond: Boolean)(ifFalse: => F[R, E, Unit]): F[R, E, Unit]
    Definition Classes
    Applicative3
    Annotations
    @inline()
  83. def void[R, E, A](r: F[R, E, A]): F[R, E, Unit]
    Definition Classes
    Functor3
  84. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  87. final def when[R, E, E1](cond: F[R, E, Boolean])(ifTrue: => F[R, E1, Unit])(implicit ev: <:<[E, E1]): F[R, E1, Unit]
    Definition Classes
    Monad3
    Annotations
    @inline()
  88. final def when[R, E](cond: Boolean)(ifTrue: => F[R, E, Unit]): F[R, E, Unit]
    Definition Classes
    Applicative3
    Annotations
    @inline()
  89. final def widen[R, E, A, A1](r: F[R, E, A])(implicit ev: <:<[A, A1]): F[R, E, A1]
    Definition Classes
    Functor3
    Annotations
    @inline()
  90. final def widenBoth[R, E, A, E1, A1](r: F[R, E, A])(implicit ev: <:<[E, E1], ev2: <:<[A, A1]): F[R, E1, A1]
    Definition Classes
    Bifunctor3
    Annotations
    @inline()
  91. final def widenError[R, E, A, E1](r: F[R, E, A])(implicit ev: <:<[E, E1]): F[R, E1, A]
    Definition Classes
    Bifunctor3
    Annotations
    @inline()
  92. 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(())
    Definition Classes
    Error3
    Annotations
    @inline()

Inherited from Error3[F]

Inherited from ErrorAccumulatingOps3[F]

Inherited from Monad3[F]

Inherited from ApplicativeError3[F]

Inherited from Bifunctor3[F]

Inherited from Guarantee3[F]

Inherited from Applicative3[F]

Inherited from Functor3[F]

Inherited from RootBifunctor[F]

Inherited from Root

Inherited from PredefinedHelper

Inherited from DivergenceHelper

Inherited from AnyRef

Inherited from Any

Ungrouped