Render a DiffResult using a lazy Builder.

Render a DiffResult using a lazy Builder, using custom RenderOpts.

Print a DiffResult to the terminal.

Print a DiffResult to the terminal, using custom RenderOpts.

Configuration type used to tweak the output of renderDiffResultWith.

Use defaultRenderOpts and the field accessors below to construct.

Sensible rendering defaults. No numbers, 2-space indentation.

How many spaces to indent each new "level" of comparison.

Whether or not to include level numbers in the output.

Render a DiffError using a lazy Builder.

Render a DiffError using a lazy Builder, using custom RenderOpts.

Render a DiffErrorNested using a lazy Builder.

Render a DiffErrorNested using a lazy Builder, using custom RenderOpts.

An intermediate representation for diff output.

We constrain output to follow a very simple pattern:

• docLines is a non-empty series of preliminary lines describing the error.
• docSubDoc is an optional Doc representing a nested error, e.g. in FieldMismatch.

Convert a DiffError to a Doc.

Render a Doc as a text Builder. This should be the only way we escape a Doc.

The output can be configured using RenderOpts.

Convert a ListDiffError to a Doc.

The first argument gives us a name for the type of list, for clearer output. For example:

ghci> putStrLn . toLazyText . renderDoc defaultRenderOpts 0 . listDiffErrorDoc "list" $ DiffAtIndex 3 TopLevelNotEqual
Diff at list index 3 (0-indexed)
  Not equal

ghci> TL.putStrLn . TB.toLazyText . renderDoc defaultRenderOpts 0 . listDiffErrorDoc "non-empty list" $ WrongLengths 3 5
non-empty lists are wrong lengths
Length of left list: 3
Length of right list: 5

Convert a DiffErrorNested to a Doc.

This is exported in the case that we want to implement an instance of Diff for an existing type (e.g. from a 3rd-party library) that does not have a Generic instance.

show a value as a Builder.

Create a simple Doc without a nested error.

Create a Doc with a non-empty list of lines and a nested error.