Class/Object

cats.effect.laws.discipline

Parameters

Related Docs: object Parameters | package discipline

Permalink

final case class Parameters(stackSafeIterationsCount: Int, allowNonTerminationLaws: Boolean) extends Product with Serializable

Parameters that can be used for tweaking how the tests behave.

stackSafeIterationsCount

specifies the number of iterations necessary in loops meant to prove stack safety; needed because these tests can be very heavy

allowNonTerminationLaws

specifies if the laws that detect non-termination (e.g. IO.never) should be enabled or not. Default is true, however if the only way to detect non-termination is to block the thread with a timeout, then that makes tests really hard to evaluate, so it's best if they are disabled

Source
Parameters.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Parameters
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Parameters(stackSafeIterationsCount: Int, allowNonTerminationLaws: Boolean)

    Permalink

    stackSafeIterationsCount

    specifies the number of iterations necessary in loops meant to prove stack safety; needed because these tests can be very heavy

    allowNonTerminationLaws

    specifies if the laws that detect non-termination (e.g. IO.never) should be enabled or not. Default is true, however if the only way to detect non-termination is to block the thread with a timeout, then that makes tests really hard to evaluate, so it's best if they are disabled

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. val allowNonTerminationLaws: Boolean

    Permalink

    specifies if the laws that detect non-termination (e.g.

    specifies if the laws that detect non-termination (e.g. IO.never) should be enabled or not. Default is true, however if the only way to detect non-termination is to block the thread with a timeout, then that makes tests really hard to evaluate, so it's best if they are disabled

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  13. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. val stackSafeIterationsCount: Int

    Permalink

    specifies the number of iterations necessary in loops meant to prove stack safety; needed because these tests can be very heavy

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

    Permalink
    Definition Classes
    AnyRef
  16. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long): Unit

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped