jon.recoil.org

Module Compilation_unit.Name

type t

The name of a compilation unit without any "-for-pack" prefix.

Printing, comparison, sets, maps, etc.

include Ocaml_utils.Identifiable.S with type t := Ocaml_typing.Compilation_unit.Name.t
include Ocaml_utils.Identifiable.Thing with type t := Ocaml_typing.Compilation_unit.Name.T.t
include Stdlib.Hashtbl.HashedType with type t := Ocaml_typing.Compilation_unit.Name.T.t

The equality predicate used to compare keys.

A hashing function on keys. It must be such that if two keys are equal according to equal, then they have identical hash values as computed by hash. Examples: suitable (equal, hash) pairs for arbitrary key types include

  • ((=), hash) for comparing objects by structure (provided objects do not contain floats)
  • ((fun x y -> compare x y = 0), hash) for comparing objects by structure and handling Stdlib.nan correctly
  • ((==), hash) for comparing objects by physical equality (e.g. for mutable or cyclic objects).
include Stdlib.Map.OrderedType with type t := Ocaml_typing.Compilation_unit.Name.T.t

A total ordering function over the keys. This is a two-argument function f such that f e1 e2 is zero if the keys e1 and e2 are equal, f e1 e2 is strictly negative if e1 is smaller than e2, and f e1 e2 is strictly positive if e1 is greater than e2. Example: a suitable ordering function is the generic structural comparison function Stdlib.compare.

dummy is a placeholder for units that does not have a valid name, as in the, or during initialisation of the compiler. It is not a valid identifier and thus cannot be generated through of_string.

val of_string : string -> Ocaml_typing.Compilation_unit.Name.t

of_string s checks the given module name is a valid compilation unit name and generates its representation.

val to_string : Ocaml_typing.Compilation_unit.Name.t -> string

The name of the distinguished compilation unit for predefined exceptions.