package jsont

  1. Overview
  2. Docs

Module Object.CaseSource

Case objects.

Case objects are used to describe objects whose members depend on the tag value of a distinguished case member. See an example.

Maps

Sourcetype 'a jsont := 'a t
Sourcetype ('cases, 'case, 'tag) map

The type for mapping a case object represented by 'case belonging to a common type represented by 'cases depending on the value of a case member of type 'tag.

Sourceval map : ?dec:('case -> 'cases) -> 'tag -> 'case jsont -> ('cases, 'case, 'tag) map

map ~dec v obj defines the object map obj as being the case for the tag value v of the case member. dec indicates how to inject the object case into the type common to all cases.

Raises Invalid_argument if obj is not a direct result of finish, that is if obj does not describe an object.

Sourceval map_tag : ('cases, 'case, 'tag) map -> 'tag

map_tag m is m's tag.

Cases

Sourcetype ('cases, 'tag) t

The type for a case of the type 'cases. This is map with its 'case representation hidden.

Sourceval make : ('cases, 'case, 'tag) map -> ('cases, 'tag) t

make map is map as a case.

Sourceval tag : ('cases, 'tag) t -> 'tag

tag c is the tag of c.

Case values

Sourcetype ('cases, 'tag) value

The type for case values. This holds a case value and its case map map. Use value to construct them.

Sourceval value : ('cases, 'case, 'tag) map -> 'case -> ('cases, 'tag) value

value map v is a case value v described by map.