docs
API
Generated with
docs/scalus/scalus.testing/ArbitraryDerivation

ArbitraryDerivation

scalus.testing.ArbitraryDerivation
object ArbitraryDerivation extends AutoDerivation[Arbitrary]

Derives an Arbitrary instance for a given type T using Magnolia.

Attributes

Example 
   given Arbitrary[AddrKeyHash] = ArbitraryDerivation.autoDerived[AddrKeyHash]
Graph
Supertypes
trait AutoDerivation[Arbitrary]
trait Derivation[Arbitrary]
trait SealedTraitDerivation
trait CommonDerivation[Arbitrary]
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

object Fallback

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Fallback.type
sealed trait Fallback[+T] extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
object NoFallback

Inherited types

type Typeclass[T] = Arbitrary[T]

Attributes

Inherited from:
CommonDerivation

Value members

Concrete methods

def join[T](caseClass: CaseClass[Arbitrary, T]): Arbitrary[T]

Must be implemented by the user of Magnolia to construct a typeclass for case class T using the provided type info. E.g. if we are deriving Show[T] typeclasses, and T is a case class Foo(...), we need to constuct Show[Foo].

Must be implemented by the user of Magnolia to construct a typeclass for case class T using the provided type info. E.g. if we are deriving Show[T] typeclasses, and T is a case class Foo(...), we need to constuct Show[Foo].

This method is called 'join' because typically it will join together the typeclasses for all the parameters of the case class, into a single typeclass for the case class itself. The field CaseClass.params can provide useful information for doing this.

Value parameters

caseClass

information about the case class T, its parameters, and their typeclasses

Attributes

def split[T](sealedTrait: SealedTrait[Arbitrary, T]): Arbitrary[T]

This must be implemented by the user of Magnolia to construct a Typeclass for 'T', where 'T' is a Sealed Trait or Scala 3 Enum, using the provided type info. E.g. if we are deriving 'Show[T]' typeclasses, and T is an enum 'Suit' (eg with values Diamonds, Clubs, etc), we need to constuct 'Show[Suit]'.

This must be implemented by the user of Magnolia to construct a Typeclass for 'T', where 'T' is a Sealed Trait or Scala 3 Enum, using the provided type info. E.g. if we are deriving 'Show[T]' typeclasses, and T is an enum 'Suit' (eg with values Diamonds, Clubs, etc), we need to constuct 'Show[Suit]'.

This method is called 'split' because it will ''split'' the different possible types of the SealedTrait, and handle each one to finally produce a typeclass capable of handling any possible subtype of the trait.

A useful function for implementing this method is SealedTrait#choose, which can take a value instance and provide information on the specific subtype of the sealedTrait which that value is.

Attributes

Inherited methods

inline def `getParams__`[T, Labels <: Tuple, Params <: Tuple](annotations: Map[String, List[Any]], inheritedAnnotations: Map[String, List[Any]], typeAnnotations: Map[String, List[Any]], repeated: Map[String, Boolean], defaults: Map[String, Option[() => Any]], idx: Int = ...): List[Param[Typeclass, T]]

Attributes

Inherited from:
CommonDerivation
inline override protected def deriveSubtype[s](m: Of[s]): Arbitrary[s]

Attributes

Definition Classes
Derivation -> SealedTraitDerivation
Inherited from:
Derivation
inline def derived[A](using Of[A]): Arbitrary[A]

Attributes

Inherited from:
Derivation
inline def derivedMirror[A](using mirror: Of[A]): Arbitrary[A]

Attributes

Inherited from:
Derivation
inline def derivedMirrorProduct[A](product: ProductOf[A]): Arbitrary[A]

Attributes

Inherited from:
CommonDerivation
inline def derivedMirrorSum[A](sum: SumOf[A]): Arbitrary[A]

Attributes

Inherited from:
Derivation
inline def getParams[T, Labels <: Tuple, Params <: Tuple](annotations: Map[String, List[Any]], typeAnnotations: Map[String, List[Any]], repeated: Map[String, Boolean], idx: Int = ...): List[Param[Typeclass, T]]

Attributes

Inherited from:
CommonDerivation
inline def getParams_[T, Labels <: Tuple, Params <: Tuple](annotations: Map[String, List[Any]], inheritedAnnotations: Map[String, List[Any]], typeAnnotations: Map[String, List[Any]], repeated: Map[String, Boolean], idx: Int = ...): List[Param[Typeclass, T]]

Attributes

Inherited from:
CommonDerivation
inline protected def sealedTraitFromMirror[A](m: SumOf[A]): SealedTrait[Typeclass, A]

Attributes

Inherited from:
SealedTraitDerivation
transparent inline def subtypes[T, SubtypeTuple <: Tuple](m: SumOf[T], idx: Int = ...): List[Subtype[Typeclass, T, _]]

Attributes

Inherited from:
Derivation
transparent inline protected def subtypesFromMirror[A, SubtypeTuple <: Tuple](m: SumOf[A], idx: Int = ..., result: List[Subtype[Typeclass, A, _]] = ...): List[Subtype[Typeclass, A, _]]

This method unrolls recursion by 16, 4, 1 steps to increase maximal size of SubtypeTuple tuple due to compiler limitation of maximal nested inlines.

This method unrolls recursion by 16, 4, 1 steps to increase maximal size of SubtypeTuple tuple due to compiler limitation of maximal nested inlines.

Attributes

Inherited from:
SealedTraitDerivation
inline protected def subtypesFromMirrorStep[A, s](m: SumOf[A], idx: Int): List[Subtype[Typeclass, A, _]]

Attributes

Inherited from:
SealedTraitDerivation

Givens

Inherited givens

inline given autoDerived[A](using Of[A]): Arbitrary[A]

Attributes

Inherited from:
AutoDerivation
Generated with