package diff

  1. Overview
  2. Docs

Module DiffSource

Sourcemodule Field : sig ... end

This module contains what might be described as faux lenses. This includes support for composition, getting, setting, etc.

Sourcetype _ spec

Specifies how the record should be traversed when a diff is computed.

Sourceval leaf : field:('a, 'b) Field.t -> equal:('b -> 'b -> bool) -> 'a spec

leaf ~field ~equal is a terminal node in the spec tree.

When computing a diff, the fields are gotten using Field.get and compared with equal. If the values are not equal, the diff includes the new value.

Sourceval child : field:('a, 'b) Field.t -> spec:'b spec -> 'a spec

child ~field ~spec is an intermediate node in the spec tree.

When computing a diff, the diff for the children is recursively computed.

Sourceval opt_child : field:('a, 'b option) Field.t -> spec:'b spec -> 'a spec

opt_child ~field ~spec is an optional intermediate node in the spec tree.

When computing a diff, the diff for the children is recursively computed if the child is present.

Sourceval many : 'a spec list -> 'a spec

many specs combines specs into a single spec

Sourcetype _ t =
  1. | Diff : {
    1. field : ('a, 'b) Field.t;
    2. new_ : 'b;
    } -> 'a t

Represents a difference between two records of the same type.

Sourceval compute : 'a -> 'a -> 'a spec -> 'a t list

compute v0 v1 spec returns a list of all the differences between v0 and v1 using spec to traverse the values.

Sourceval apply : 'a -> 'a t -> 'a

apply v diff returns v with diff applied

Sourceval apply_all : 'a -> 'a t list -> 'a

apply_all v diffs returns v with all diffs applied