package orsetto
Install
Dune Dependency
Authors
Maintainers
Sources
sha512=e260412b2dd0f98cfe3dc7ed5c31a694eb31c93cd207c51fa12675b790234ee0ad3bf07d9be17a4dc266fedfe55b14c967cad7bc0c9414063eef8afd59f3d0d1
doc/orsetto.cf/Cf_annot/Create/argument-1-B/Meta/index.html
Module B.Meta
The specification of structural metadata.
val default_fields : fields listIf a list of fields is not provided to the meta formatter, then this default_fields is used.
val symbol_type : Symbol.t Cf_type.nymThe witness for the symbol type.
val of_opaque_position :
?style:[< Meta.style ] ->
?fields:fields list ->
Cf_type.opaque ->
Position.tAnnotation 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:[< Meta.style ] ->
?fields:fields list ->
Position.t ->
Cf_type.opaqueAnnotation 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.