package orsetto

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters for configuring structured interchange of annotations.

type symbol

The basis symbol type.

type position

The position type.

type fields

Relevant portions of position types are identified by this type.

val default_fields : fields list

If a list of fields is not provided to the meta formatter, then this default_fields is used.

val symbol_type : symbol Cf_type.nym

The witness for the symbol type.

val of_opaque_position : ?style:[< style ] -> ?fields:fields list -> Cf_type.opaque -> position

Annotation profiles use of_opaque_position v to translate v into a position value provided it was decoded from an interchange language representation produced by to_opaque_position above.

The ~style parameter controls whether and how record and variant names should be decoded from the opaque value.

The ~fields parameters facilitates controlling which portions of the position record are required to be present in the decoded value. Default values for fields not required should be used if not present in the decoded value.

Raises Cf_type.Type_error if the type witnessed by v is wrong according to style and fields required. Raises Failure if the witness is correct but the underlying value is unsound.

val to_opaque_position : ?style:[< style ] -> ?fields:fields list -> position -> Cf_type.opaque

Annotation profiles use to_opaque_position p to translate p into an opaque value ready to encode in an interchange language.

The ~style parameter controls whether and how record and variant names are encoded in the opaque value.

The ~fields parameter facilitates controlling which portions of the position record are to be included in the serialized octets.