difflicious-circe
API
Generated with
difflicious-circe/difflicious.circe/JsonDiffer

JsonDiffer

difflicious.circe.JsonDiffer
See theJsonDiffer companion object
final class JsonDiffer extends Differ[Json]

Attributes

Companion
object
Graph
Supertypes
trait Differ[Json]
trait ConfigureMethods[Json]
class Object
trait Matchable
class Any

Members list

Type members

Types

override type R = DiffResult

Value members

Concrete methods

override def diff(inputs: DiffInput[Json]): DiffResult

Attributes

Definition Classes
Differ

Inherited methods

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

Attributes

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

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 diff(obtained: Json, expected: Json): R

Attributes

Inherited from:
Differ
def ignore: Differ[Json]

Attributes

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

Attributes

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

Attributes

Inherited from:
ConfigureMethods
def unignore: Differ[Json]

Attributes

Inherited from:
Differ

Inherited fields

val requiredShapeMsg: String

Attributes

Inherited from:
ConfigureMethods
Generated with