difflicious-core
API
Generated with
difflicious-core/difflicious/difflicious.differ

difflicious.differ

package difflicious.differ

Members list

Type members

Classlikes

final class EqualsDiffer[T](isIgnored: Boolean, valueToString: T => String) extends ValueDiffer[T]

Differ where the two values are compared by using the equals method. If the two values aren't equal, then we use the provided valueToString function to output the diagnostic output.

Differ where the two values are compared by using the equals method. If the two values aren't equal, then we use the provided valueToString function to output the diagnostic output.

Attributes

Supertypes
trait ValueDiffer[T]
trait Differ[T]
trait ConfigureMethods[T]
class Object
trait Matchable
class Any
Show all
final class LazyDiffer[T](mkDiffer: => Differ[T]) extends Differ[T]

A wrapper over another Differ that lazily initializes it when needed. Used to break self-referencing cycles such as recursive data structures

A wrapper over another Differ that lazily initializes it when needed. Used to break self-referencing cycles such as recursive data structures

Attributes

Companion
object
Supertypes
trait Differ[T]
trait ConfigureMethods[T]
class Object
trait Matchable
class Any
object LazyDiffer

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
LazyDiffer.type
class MapDiffer[M[_, _], K, V](isIgnored: Boolean, keyDiffer: ValueDiffer[K], valueDiffer: Differ[V], typeName: SomeTypeName, asMap: MapLike[M]) extends Differ[M[K, V]]

Attributes

Companion
object
Supertypes
trait Differ[M[K, V]]
trait ConfigureMethods[M[K, V]]
class Object
trait Matchable
class Any
object MapDiffer

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
MapDiffer.type
object NumericDiffer

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class NumericDiffer[T](isIgnored: Boolean, numeric: Numeric[T], valueToString: T => String) extends ValueDiffer[T]

Attributes

Companion
object
Supertypes
trait ValueDiffer[T]
trait Differ[T]
trait ConfigureMethods[T]
class Object
trait Matchable
class Any
Show all
final class OneOfDiffer[A](cases: Vector[Case[A, _]], isIgnored: Boolean, differTypeName: String) extends Differ[A]

Attributes

Companion
object
Supertypes
trait Differ[A]
trait ConfigureMethods[A]
class Object
trait Matchable
class Any
object OneOfDiffer

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ProductDiffer[T](fieldDiffers: Vector[(String, Differ[Any])], isIgnored: Boolean, typeName: SomeTypeName) extends Differ[T]

A differ for product data structures such as tuples and case classes.

A differ for product data structures such as tuples and case classes.

Attributes

Supertypes
trait Differ[T]
trait ConfigureMethods[T]
class Object
trait Matchable
class Any
final class RecordDiffer[T](fieldDiffers: ListMap[String, (T => Any, Differ[Any])], isIgnored: Boolean, typeName: SomeTypeName) extends Differ[T]

A differ for a record-like data structure such as tuple or case classes.

A differ for a record-like data structure such as tuple or case classes.

Attributes

Supertypes
trait Differ[T]
trait ConfigureMethods[T]
class Object
trait Matchable
class Any
object SeqDiffer

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
SeqDiffer.type
final class SeqDiffer[F[_], A](isIgnored: Boolean, pairBy: PairBy[A], itemDiffer: Differ[A], typeName: SomeTypeName, asSeq: SeqLike[F]) extends Differ[F[A]]

Attributes

Companion
object
Supertypes
trait Differ[F[A]]
trait ConfigureMethods[F[A]]
class Object
trait Matchable
class Any
final class SetDiffer[F[_], A](isIgnored: Boolean, itemDiffer: Differ[A], matchFunc: A => Any, typeName: SomeTypeName, asSet: SetLike[F]) extends Differ[F[A]]

Attributes

Companion
object
Supertypes
trait Differ[F[A]]
trait ConfigureMethods[F[A]]
class Object
trait Matchable
class Any
object SetDiffer

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
SetDiffer.type
class TransformedDiffer[T, U](underlyingDiffer: ValueDiffer[U], transformFunc: T => U) extends ValueDiffer[T]

A Differ that transforms any input of diff method and pass it to its underlying Differ. See ValueDiffer.contramap

A Differ that transforms any input of diff method and pass it to its underlying Differ. See ValueDiffer.contramap

Attributes

Supertypes
trait ValueDiffer[T]
trait Differ[T]
trait ConfigureMethods[T]
class Object
trait Matchable
class Any
Show all
trait ValueDiffer[T] extends Differ[T]

Differ where the error diagnostic output is just string values. Simple types where a string representation is enough for diagnostics purposes should use Differ.useEquals (EqualsDiffer is a subtype of this trait). For example, Differ for Int, String, java.time.Instant are all ValueDiffers.

Differ where the error diagnostic output is just string values. Simple types where a string representation is enough for diagnostics purposes should use Differ.useEquals (EqualsDiffer is a subtype of this trait). For example, Differ for Int, String, java.time.Instant are all ValueDiffers.

This trait also provide an extra contramap method which makes it easy to write instances for newtypes / opaque types.

Attributes

Supertypes
trait Differ[T]
trait ConfigureMethods[T]
class Object
trait Matchable
class Any
Known subtypes
class EqualsDiffer[T]
class NumericDiffer[T]
class TransformedDiffer[T, U]
Generated with