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], DeferLaws[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. DeferLaws
  5. BracketLaws
  6. MonadErrorLaws
  7. MonadLaws
  8. FlatMapLaws
  9. ApplicativeErrorLaws
  10. ApplicativeLaws
  11. ApplyLaws
  12. SemigroupalLaws
  13. FunctorLaws
  14. InvariantLaws
  15. AnyRef
  16. 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 → DeferLaws → 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 bracketCaseFailureInAcquisitionRemainsFailure[A, B](e: Throwable, f: (A) ⇒ F[B], release: F[Unit]): IsEq[F[B]]

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    BracketLaws

  29. def bracketReleaseIsCalledOnCompletedOrError[A, B](fa: F[A], b: B): IsEq[F[B]]

    Permalink
    Definition Classes
    AsyncLaws

  30. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    FunctorLaws

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

    Permalink
    Definition Classes
    FunctorLaws

  33. def deferDoesNotEvaluate[A](fa: (Unit) ⇒ F[A]): IsEq[Boolean]

    Permalink
    Definition Classes
    DeferLaws

  34. def deferIdentity[A](fa: (Unit) ⇒ F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    DeferLaws

  35. def deferIsStackSafe[A](fa: (Unit) ⇒ F[A]): IsEq[F[A]]

    Permalink
    Definition Classes
    DeferLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    AnyRef

  39. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  40. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    FlatMapLaws

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

    Permalink
    Definition Classes
    FlatMapLaws

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

    Permalink
    Definition Classes
    FlatMapLaws

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

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

  51. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

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

    Permalink
    Definition Classes
    InvariantLaws

  54. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

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

    Permalink
    Definition Classes
    MonadLaws

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

    Permalink
    Definition Classes
    MonadLaws

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

    Permalink
    Definition Classes
    ApplyLaws

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

    Permalink
    Definition Classes
    ApplyLaws

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

    Permalink
    Definition Classes
    MonadLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    MonadErrorLaws

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

    Permalink
    Definition Classes
    MonadErrorLaws

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

    Permalink
    Definition Classes
    MonadErrorLaws

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

    Permalink
    Definition Classes
    MonadLaws

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

    Permalink
    Definition Classes
    MonadLaws

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

    Permalink
    Definition Classes
    ApplicativeLaws

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

    Permalink
    Definition Classes
    ApplicativeLaws

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

    Permalink
    Definition Classes
    FlatMapLaws

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AsyncLaws

  72. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  73. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

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

    Permalink
    Definition Classes
    ApplyLaws

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

    Permalink
    Definition Classes
    ApplyLaws

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

    Permalink
    Definition Classes
    AsyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

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

    Permalink
    Definition Classes
    ApplicativeErrorLaws

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

    Permalink
    Definition Classes
    AsyncLaws

  84. def repeatedAsyncFEvaluationNotMemoized[A](a: A, f: (A) ⇒ A): IsEq[F[A]]

    Permalink
    Definition Classes
    AsyncLaws

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

    Permalink
    Definition Classes
    AsyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    MonadErrorLaws

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

    Permalink

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

    Permalink

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

    Permalink

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

  92. def stackSafetyOfBracketOnRepeatedLeftBinds(iterations: Int): IsEq[F[Unit]]

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    SyncLaws

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    FlatMapLaws

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

    Permalink
    Definition Classes
    MonadLaws

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

    Permalink

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

    Permalink

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

    Permalink

  108. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    BracketLaws

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

    Permalink
    Definition Classes
    SyncLaws

  111. final def wait(): Unit

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

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

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

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

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

Inherited from AsyncLaws[F]

Inherited from SyncLaws[F]

Inherited from DeferLaws[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