Trait/Object

cats.effect.laws

BracketLaws

Related Docs: object BracketLaws | package laws

Permalink

trait BracketLaws[F[_], E] extends MonadErrorLaws[F, E]

Source
BracketLaws.scala
Linear Supertypes
MonadErrorLaws[F, E], MonadLaws[F], FlatMapLaws[F], ApplicativeErrorLaws[F, E], ApplicativeLaws[F], ApplyLaws[F], SemigroupalLaws[F], FunctorLaws[F], InvariantLaws[F], AnyRef, Any
Known Subclasses
AsyncLaws, ConcurrentEffectLaws, ConcurrentLaws, EffectLaws, SyncLaws
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BracketLaws
  2. MonadErrorLaws
  3. MonadLaws
  4. FlatMapLaws
  5. ApplicativeErrorLaws
  6. ApplicativeLaws
  7. ApplyLaws
  8. SemigroupalLaws
  9. FunctorLaws
  10. InvariantLaws
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. implicit abstract def F: Bracket[F, E]

    Permalink
    Definition Classes
    BracketLaws → MonadErrorLaws → MonadLaws → FlatMapLaws → ApplicativeErrorLaws → ApplicativeLaws → ApplyLaws → SemigroupalLaws → FunctorLaws → InvariantLaws

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def acquireAndReleaseAreUncancelable[A, B](fa: F[A], use: (A) ⇒ F[B], release: (A) ⇒ F[Unit]): IsEq[F[B]]

    Permalink

  5. def adaptErrorPure[A](a: A, f: (E) ⇒ E): IsEq[F[A]]

    Permalink
    Definition Classes
    MonadErrorLaws

  6. def adaptErrorRaise[A](e: E, f: (E) ⇒ E): IsEq[F[A]]

    Permalink
    Definition Classes
    MonadErrorLaws

  7. def apProductConsistent[A, B](fa: F[A], f: F[(A) ⇒ B]): IsEq[F[B]]

    Permalink
    Definition Classes
    ApplicativeLaws

  8. def applicativeComposition[A, B, C](fa: F[A], fab: F[(A) ⇒ B], fbc: F[(B) ⇒ C]): IsEq[F[C]]

    Permalink
    Definition Classes
    ApplicativeLaws

  9. def applicativeErrorHandle[A](e: E, f: (E) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  10. def applicativeErrorHandleWith[A](e: E, f: (E) ⇒ F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  11. def applicativeHomomorphism[A, B](a: A, f: (A) ⇒ B): IsEq[F[B]]

    Permalink
    Definition Classes
    ApplicativeLaws

  12. def applicativeIdentity[A](fa: F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeLaws

  13. def applicativeInterchange[A, B](a: A, ff: F[(A) ⇒ B]): IsEq[F[B]]

    Permalink
    Definition Classes
    ApplicativeLaws

  14. def applicativeMap[A, B](fa: F[A], f: (A) ⇒ B): IsEq[F[B]]

    Permalink
    Definition Classes
    ApplicativeLaws

  15. def applicativeUnit[A](a: A): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeLaws

  16. def applyComposition[A, B, C](fa: F[A], fab: F[(A) ⇒ B], fbc: F[(B) ⇒ C]): IsEq[F[C]]

    Permalink
    Definition Classes
    ApplyLaws

  17. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  18. def attemptConsistentWithAttemptT[A](fa: F[A]): IsEq[EitherT[F, E, A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  19. def attemptFromEitherConsistentWithPure[A](eab: Either[E, A]): IsEq[F[Either[E, A]]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  20. def bracketCaseFailureInAcquisitionRemainsFailure[A, B](e: E, f: (A) ⇒ F[B], release: F[Unit]): IsEq[F[B]]

    Permalink

  21. def bracketCaseWithPureUnitIsEqvMap[A, B](fa: F[A], f: (A) ⇒ B): IsEq[F[B]]

    Permalink

  22. def bracketCaseWithPureUnitIsUncancelable[A, B](fa: F[A], f: (A) ⇒ F[B]): IsEq[F[B]]

    Permalink

  23. def bracketIsDerivedFromBracketCase[A, B](fa: F[A], use: (A) ⇒ F[B], release: (A) ⇒ F[Unit]): IsEq[F[B]]

    Permalink

  24. def bracketPropagatesTransformerEffects[M[_], A, B](fromM: ~>[M, F])(acquire: F[A], use: (A) ⇒ F[B], release: (A) ⇒ M[Unit]): IsEq[F[B]]

    Permalink

  25. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. def covariantComposition[A, B, C](fa: F[A], f: (A) ⇒ B, g: (B) ⇒ C): IsEq[F[C]]

    Permalink
    Definition Classes
    FunctorLaws

  27. def covariantIdentity[A](fa: F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    FunctorLaws

  28. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  29. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  30. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  31. def flatMapAssociativity[A, B, C](fa: F[A], f: (A) ⇒ F[B], g: (B) ⇒ F[C]): IsEq[F[C]]

    Permalink
    Definition Classes
    FlatMapLaws

  32. def flatMapConsistentApply[A, B](fa: F[A], fab: F[(A) ⇒ B]): IsEq[F[B]]

    Permalink
    Definition Classes
    FlatMapLaws

  33. def flatMapFromTailRecMConsistency[A, B](fa: F[A], fn: (A) ⇒ F[B]): IsEq[F[B]]

    Permalink
    Definition Classes
    FlatMapLaws

  34. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  35. def guaranteeCaseIsDerivedFromBracketCase[A](fa: F[A], finalizer: (ExitCase[E]) ⇒ F[Unit]): IsEq[F[A]]

    Permalink

  36. def guaranteeIsDerivedFromBracket[A](fa: F[A], finalizer: F[Unit]): IsEq[F[A]]

    Permalink

  37. def handleErrorConsistentWithRecover[A](fa: F[A], f: (E) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  38. def handleErrorPure[A](a: A, f: (E) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  39. def handleErrorWithConsistentWithRecoverWith[A](fa: F[A], f: (E) ⇒ F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  40. def handleErrorWithPure[A](a: A, f: (E) ⇒ F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  41. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  42. def invariantComposition[A, B, C](fa: F[A], f1: (A) ⇒ B, f2: (B) ⇒ A, g1: (B) ⇒ C, g2: (C) ⇒ B): IsEq[F[C]]

    Permalink
    Definition Classes
    InvariantLaws

  43. def invariantIdentity[A](fa: F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    InvariantLaws

  44. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  45. def kleisliAssociativity[A, B, C, D](f: (A) ⇒ F[B], g: (B) ⇒ F[C], h: (C) ⇒ F[D], a: A): IsEq[F[D]]

    Permalink
    Definition Classes
    FlatMapLaws

  46. def kleisliLeftIdentity[A, B](a: A, f: (A) ⇒ F[B]): IsEq[F[B]]

    Permalink
    Definition Classes
    MonadLaws

  47. def kleisliRightIdentity[A, B](a: A, f: (A) ⇒ F[B]): IsEq[F[B]]

    Permalink
    Definition Classes
    MonadLaws

  48. def map2EvalConsistency[A, B, C](fa: F[A], fb: F[B], f: (A, B) ⇒ C): IsEq[F[C]]

    Permalink
    Definition Classes
    ApplyLaws

  49. def map2ProductConsistency[A, B, C](fa: F[A], fb: F[B], f: (A, B) ⇒ C): IsEq[F[C]]

    Permalink
    Definition Classes
    ApplyLaws

  50. def mapFlatMapCoherence[A, B](fa: F[A], f: (A) ⇒ B): IsEq[F[B]]

    Permalink
    Definition Classes
    MonadLaws

  51. def monadErrorEnsureConsistency[A](fa: F[A], e: E, p: (A) ⇒ Boolean): IsEq[F[A]]

    Permalink
    Definition Classes
    MonadErrorLaws

  52. def monadErrorEnsureOrConsistency[A](fa: F[A], e: (A) ⇒ E, p: (A) ⇒ Boolean): IsEq[F[A]]

    Permalink
    Definition Classes
    MonadErrorLaws

  53. def monadErrorLeftZero[A, B](e: E, f: (A) ⇒ F[B]): IsEq[F[B]]

    Permalink
    Definition Classes
    MonadErrorLaws

  54. def monadLeftIdentity[A, B](a: A, f: (A) ⇒ F[B]): IsEq[F[B]]

    Permalink
    Definition Classes
    MonadLaws

  55. def monadRightIdentity[A](fa: F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    MonadLaws

  56. def monoidalLeftIdentity[A](fa: F[A]): (F[(Unit, A)], F[A])

    Permalink
    Definition Classes
    ApplicativeLaws

  57. def monoidalRightIdentity[A](fa: F[A]): (F[(A, Unit)], F[A])

    Permalink
    Definition Classes
    ApplicativeLaws

  58. def mproductConsistency[A, B](fa: F[A], fb: (A) ⇒ F[B]): IsEq[F[(A, B)]]

    Permalink
    Definition Classes
    FlatMapLaws

  59. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  60. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  61. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  62. def onErrorPure[A](a: A, f: (E) ⇒ F[Unit]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  63. def onErrorRaise[A](fa: F[A], e: E, fb: F[Unit]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  64. def productLConsistency[A, B](fa: F[A], fb: F[B]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplyLaws

  65. def productRConsistency[A, B](fa: F[A], fb: F[B]): IsEq[F[B]]

    Permalink
    Definition Classes
    ApplyLaws

  66. def pureAttempt[A](a: A): IsEq[F[Either[E, A]]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  67. def raiseErrorAttempt(e: E): IsEq[F[Either[E, Unit]]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  68. def recoverConsistentWithRecoverWith[A](fa: F[A], pf: PartialFunction[E, A]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  69. def rethrowAttempt[A](fa: F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    MonadErrorLaws

  70. def semigroupalAssociativity[A, B, C](fa: F[A], fb: F[B], fc: F[C]): (F[(A, (B, C))], F[((A, B), C)])

    Permalink
    Definition Classes
    SemigroupalLaws

  71. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  72. def tailRecMConsistentFlatMap[A](a: A, f: (A) ⇒ F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    FlatMapLaws

  73. lazy val tailRecMStackSafety: IsEq[F[Int]]

    Permalink
    Definition Classes
    MonadLaws

  74. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  75. def uncancelablePreventsCanceledCase[A](fa: F[A], onCancel: F[Unit], onFinish: F[Unit]): IsEq[F[A]]

    Permalink

  76. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  77. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  78. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MonadErrorLaws[F, E]

Inherited from MonadLaws[F]

Inherited from FlatMapLaws[F]

Inherited from ApplicativeErrorLaws[F, E]

Inherited from ApplicativeLaws[F]

Inherited from ApplyLaws[F]

Inherited from SemigroupalLaws[F]

Inherited from FunctorLaws[F]

Inherited from InvariantLaws[F]

Inherited from AnyRef

Inherited from Any

Ungrouped