Up  

Module Assemblage.Private.Conf.Key

module Key: sig .. end
Configuration keys.

Existential keys


type t =
| V : 'a key -> t
The type for existential keys.
val hide_type : 'a key -> t
hide_type k hides the type parameter of k.
val equal : t -> t -> bool
equal k k' is true iff name k = name k'.
val compare : t -> t -> int
compare k k' compares k and k' and is compatible with Assemblage.Private.Conf.Key.equal.

Typed key accessors


val id : 'a key -> int
id k is the unique id of the key.
val name : 'a key -> string
name k is k's name.
val public : 'a key -> bool
public k is k's public status.
val converter : 'a key -> 'a converter
converter k is k's value type converter.
val default : 'a key -> 'a value
default k is k's default value.
val doc : 'a key -> string option
doc k is k's documentation string (if any).
val docv : 'a key -> string option
docv k is k's value documentation meta-variable (if any).
val docs : 'a key -> string option
docs k is k's documentation section (if any).

Key sets and maps


module Set: sig .. end
module Map: sig .. end