Trait/Object

cats.effect.laws

EffectLaws

Related Docs: object EffectLaws | package laws

Permalink

trait EffectLaws[F[_]] extends AsyncLaws[F]

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

Abstract Value Members

  1. implicit abstract def F: Effect[F]

    Permalink
    Definition Classes
    EffectLaws → AsyncLaws → SyncLaws → 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
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    MonadErrorLaws

  6. def adaptErrorRaise[A](e: Throwable, f: (Throwable) ⇒ Throwable): 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: Throwable, f: (Throwable) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  10. def applicativeErrorHandleWith[A](e: Throwable, f: (Throwable) ⇒ 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 asyncCanBeDerivedFromAsyncF[A](k: ((Either[Throwable, A]) ⇒ Unit) ⇒ Unit): IsEq[F[A]]

    Permalink
    Definition Classes
    AsyncLaws

  19. def asyncLeftIsRaiseError[A](e: Throwable): IsEq[F[A]]

    Permalink
    Definition Classes
    AsyncLaws

  20. def asyncRightIsPure[A](a: A): IsEq[F[A]]

    Permalink
    Definition Classes
    AsyncLaws

  21. def attemptConsistentWithAttemptT[A](fa: F[A]): IsEq[EitherT[F, Throwable, A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  22. def attemptFromEitherConsistentWithPure[A](eab: Either[Throwable, A]): IsEq[F[Either[Throwable, A]]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  23. def bindSuspendsEvaluation[A](fa: F[A], a1: A, f: (A, A) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    SyncLaws

  24. def bracketCaseEmitsUseFailure[A](e: Throwable, e2: Throwable, fa: F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    BracketLaws

  29. def bracketReleaseCalledForError[A](a: A, f: (A) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    SyncLaws

  30. def bracketReleaseCalledForSuccess[A, B, C](fa: F[A], b: B, c: C, f: (A, C) ⇒ C): IsEq[F[C]]

    Permalink
    Definition Classes
    SyncLaws

  31. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    FunctorLaws

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

    Permalink
    Definition Classes
    FunctorLaws

  34. def delayConstantIsPure[A](a: A): IsEq[F[A]]

    Permalink
    Definition Classes
    SyncLaws

  35. def delayThrowIsRaiseError[A](e: Throwable): IsEq[F[A]]

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    AnyRef

  37. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  38. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    FlatMapLaws

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

    Permalink
    Definition Classes
    FlatMapLaws

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

    Permalink
    Definition Classes
    FlatMapLaws

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

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    BracketLaws

  45. def handleErrorConsistentWithRecover[A](fa: F[A], f: (Throwable) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  46. def handleErrorPure[A](a: A, f: (Throwable) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  47. def handleErrorWithConsistentWithRecoverWith[A](fa: F[A], f: (Throwable) ⇒ F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  48. def handleErrorWithPure[A](a: A, f: (Throwable) ⇒ F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  49. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

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

    Permalink
    Definition Classes
    InvariantLaws

  52. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

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

    Permalink
    Definition Classes
    MonadLaws

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

    Permalink
    Definition Classes
    MonadLaws

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

    Permalink
    Definition Classes
    ApplyLaws

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

    Permalink
    Definition Classes
    ApplyLaws

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

    Permalink
    Definition Classes
    MonadLaws

  59. def mapSuspendsEvaluation[A](fa: F[A], a1: A, f: (A, A) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    MonadErrorLaws

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

    Permalink
    Definition Classes
    MonadErrorLaws

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

    Permalink
    Definition Classes
    MonadErrorLaws

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

    Permalink
    Definition Classes
    MonadLaws

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

    Permalink
    Definition Classes
    MonadLaws

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

    Permalink
    Definition Classes
    ApplicativeLaws

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

    Permalink
    Definition Classes
    ApplicativeLaws

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

    Permalink
    Definition Classes
    FlatMapLaws

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

    Permalink
    Definition Classes
    AnyRef

  69. def neverIsDerivedFromAsync[A]: IsEq[F[A]]

    Permalink
    Definition Classes
    AsyncLaws

  70. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  71. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

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

    Permalink
    Definition Classes
    ApplyLaws

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

    Permalink
    Definition Classes
    ApplyLaws

  76. def propagateErrorsThroughBindAsync[A](t: Throwable): IsEq[F[Either[Throwable, A]]]

    Permalink
    Definition Classes
    AsyncLaws

  77. def propagateErrorsThroughBindSuspend[A](t: Throwable): IsEq[F[A]]

    Permalink
    Definition Classes
    SyncLaws

  78. def pureAttempt[A](a: A): IsEq[F[Either[Throwable, A]]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  79. def raiseErrorAttempt(e: Throwable): IsEq[F[Either[Throwable, Unit]]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  80. def recoverConsistentWithRecoverWith[A](fa: F[A], pf: PartialFunction[Throwable, A]): IsEq[F[A]]

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  81. def repeatedAsyncEvaluationNotMemoized[A](a: A, f: (A) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    AsyncLaws

  82. def repeatedCallbackIgnored[A](a: A, f: (A) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    AsyncLaws

  83. def repeatedSyncEvaluationNotMemoized[A](a: A, f: (A) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    MonadErrorLaws

  85. def runAsyncIgnoresErrorInHandler[A](e: Throwable): IsEq[IO[Unit]]

    Permalink

  86. def runAsyncPureProducesRightIO[A](a: A): IsEq[IO[Either[Throwable, A]]]

    Permalink

  87. def runAsyncRaiseErrorProducesLeftIO[A](e: Throwable): IsEq[IO[Either[Throwable, A]]]

    Permalink

  88. def runSyncStepAsyncProducesLeftPureIO[A](k: ((Either[Throwable, A]) ⇒ Unit) ⇒ Unit): IsEq[IO[Either[F[A], A]]]

    Permalink

  89. def runSyncStepCanBeAttemptedSynchronously[A](fa: F[A]): Boolean

    Permalink

  90. def runSyncStepRunAsyncConsistency[A](fa: F[A]): IsEq[IO[A]]

    Permalink

  91. def runSyncStepSuspendPureProducesTheSame[A](fa: F[A]): IsEq[IO[Either[F[A], A]]]

    Permalink

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

  93. def stackSafetyOnRepeatedAttempts(iterations: Int): IsEq[F[Unit]]

    Permalink
    Definition Classes
    SyncLaws

  94. def stackSafetyOnRepeatedLeftBinds(iterations: Int): IsEq[F[Unit]]

    Permalink
    Definition Classes
    SyncLaws

  95. def stackSafetyOnRepeatedMaps(iterations: Int): IsEq[F[Int]]

    Permalink
    Definition Classes
    SyncLaws

  96. def stackSafetyOnRepeatedRightBinds(iterations: Int): IsEq[F[Unit]]

    Permalink
    Definition Classes
    SyncLaws

  97. def suspendConstantIsPureJoin[A](fa: F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    SyncLaws

  98. def suspendThrowIsRaiseError[A](e: Throwable): IsEq[F[A]]

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    FlatMapLaws

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

    Permalink
    Definition Classes
    MonadLaws

  102. def toIORunAsyncConsistency[A](fa: F[A]): IsEq[IO[A]]

    Permalink

  103. def toIOStackSafety[A](iterations: Int)(fa: F[A]): IsEq[IO[A]]

    Permalink

  104. def toIOinverseOfLiftIO[A](ioa: IO[A]): IsEq[IO[A]]

    Permalink

  105. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    BracketLaws

  107. def unsequencedDelayIsNoop[A](a: A, f: (A) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    SyncLaws

  108. final def wait(): Unit

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

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

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

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

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

Inherited from AsyncLaws[F]

Inherited from SyncLaws[F]

Inherited from BracketLaws[F, Throwable]

Inherited from MonadErrorLaws[F, Throwable]

Inherited from MonadLaws[F]

Inherited from FlatMapLaws[F]

Inherited from ApplicativeErrorLaws[F, Throwable]

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