difflicious-core
API
Generated with
difflicious-core/difflicious/Differ

Differ

difflicious.Differ
See theDiffer companion object
trait Differ[T] extends ConfigureMethods[T]

Attributes

Companion
object
Graph
Supertypes
trait ConfigureMethods[T]
class Object
trait Matchable
class Any
Known subtypes
class MapDiffer[M, K, V]
class RecordDiffer[T]
class SeqDiffer[F, A]
class SetDiffer[F, A]
trait ValueDiffer[T]
class EqualsDiffer[T]
class NumericDiffer[T]
class TransformedDiffer[T, U]
Show all

Members list

Type members

Types

type R <: DiffResult
Implicitly added by optionDiffer
type R <: DiffResult

Value members

Abstract methods

def diff(inputs: DiffInput[T]): R
Implicitly added by optionDiffer
def diff(inputs: DiffInput[T]): R

Concrete methods

final def configureRaw(path: ConfigurePath, operation: ConfigureOp): Either[ConfigureError, Differ[T]]
Implicitly added by optionDiffer

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

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

final def diff(obtained: T, expected: T): R
Implicitly added by optionDiffer
final def diff(obtained: T, expected: T): R
def ignore: Differ[T]
Implicitly added by optionDiffer
def ignore: Differ[T]
def unignore: Differ[T]
Implicitly added by optionDiffer
def unignore: Differ[T]

Inherited methods

inline def configure[U](inline path: T => U)(configFunc: Differ[U] => Differ[U]): Differ[T]
Implicitly added by optionDiffer

Attributes

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

Attributes

Inherited from:
ConfigureMethods
inline def ignoreAt[U](inline path: T => U): Differ[T]
Implicitly added by optionDiffer

Attributes

Inherited from:
ConfigureMethods
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]
Implicitly added by optionDiffer

Attributes

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

Attributes

Inherited from:
ConfigureMethods

Inherited fields

val requiredShapeMsg: String
Implicitly added by optionDiffer

Attributes

Inherited from:
ConfigureMethods
val requiredShapeMsg: String

Attributes

Inherited from:
ConfigureMethods
Generated with