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

EqualsDiffer

difflicious.differ.EqualsDiffer
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.

Attributes

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

Members list

Type members

Inherited types

final override type R = ValueResult

Attributes

Inherited from:
ValueDiffer

Value members

Concrete methods

override def configureIgnored(newIgnored: Boolean): EqualsDiffer[T]

Attributes

Definition Classes
override def configurePairBy(path: ConfigurePath, op: PairBy[_]): Either[ConfigureError, EqualsDiffer[T]]

Attributes

Definition Classes
override def configurePath(step: String, nextPath: ConfigurePath, op: ConfigureOp): Either[ConfigureError, EqualsDiffer[T]]

Attributes

Definition Classes
override def diff(inputs: DiffInput[T]): ValueResult

Attributes

Definition Classes

Inherited methods

inline def configure[U](inline path: T => U)(configFunc: Differ[U] => Differ[U]): Differ[T]

Attributes

Inherited from:
ConfigureMethods
final def configureRaw(path: ConfigurePath, operation: ConfigureOp): Either[ConfigureError, Differ[T]]

Attempt to change the configuration of this Differ. If successful, a new differ with the updated configuration will be returned.

Attempt to change the configuration of this Differ. If successful, a new differ with the updated configuration will be returned.

The configuration change can fail due to

  • bad "path" that does not match the internal structure of the Differ
  • The path resolved correctly, but the configuration update operation cannot be applied for that part of the Differ (e.g. wrong type or wrong operation)

Value parameters

operation

The configuration change operation you want to perform on the target sub-Differ

path

The path to traverse to the sub-Differ

Attributes

Inherited from:
Differ
final def contramap[S](transformFunc: S => T): TransformedDiffer[S, T]

Attributes

Inherited from:
ValueDiffer
final def diff(obtained: T, expected: T): R

Attributes

Inherited from:
Differ
def ignore: Differ[T]

Attributes

Inherited from:
Differ
inline def ignoreAt[U](inline path: T => U): Differ[T]

Attributes

Inherited from:
ConfigureMethods
inline def replace[U](inline path: T => U)(newDiffer: Differ[U]): Differ[T]

Attributes

Inherited from:
ConfigureMethods
def unignore: Differ[T]

Attributes

Inherited from:
Differ

Inherited fields

val requiredShapeMsg: String

Attributes

Inherited from:
ConfigureMethods
Generated with