Module `Flambda2_identifiers.Symbol`

A symbol identifies a piece of statically-allocated data. The linkage name must be unique across the whole program.

include module type of struct include Flambda2_identifiers.Int_ids.Symbol end

type t = private Flambda2_algorithms.Table_by_int_id.Id.t

type exported = Flambda2_identifiers.Int_ids.Symbol.exported

include Flambda2_algorithms.Container_types.S_plus_iterator
  with type t := Flambda2_identifiers.Symbol.t

module T = Flambda2_identifiers.Int_ids.Symbol.T

include Flambda2_algorithms.Container_types_intf.Thing with type t := T.t

include Stdlib.Hashtbl.HashedType with type t := T.t

val equal : T.t -> T.t -> bool

The equality predicate used to compare keys.

val hash : T.t -> int

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 := T.t

val compare : T.t -> T.t -> int

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.

val print : Stdlib.Format.formatter -> T.t -> unit

module Set = Flambda2_identifiers.Int_ids.Symbol.Set

module Map = Flambda2_identifiers.Int_ids.Symbol.Map

val create : 
  Compilation_unit.t ->
  Linkage_name.t ->
  Flambda2_identifiers.Symbol.t

val create_wrapped : Flambda2_import.Symbol.t -> Flambda2_identifiers.Symbol.t

val unsafe_create : 
  Compilation_unit.t ->
  Linkage_name.t ->
  Flambda2_identifiers.Symbol.t

val compilation_unit : Flambda2_identifiers.Symbol.t -> Compilation_unit.t

val for_compilation_unit : Compilation_unit.t -> Flambda2_identifiers.Symbol.t

val linkage_name : Flambda2_identifiers.Symbol.t -> Linkage_name.t

val linkage_name_as_string : Flambda2_identifiers.Symbol.t -> string

val export : 
  Flambda2_identifiers.Symbol.t ->
  Flambda2_identifiers.Symbol.exported

val import : 
  Flambda2_identifiers.Symbol.exported ->
  Flambda2_identifiers.Symbol.t

val external_symbols_compilation_unit : unit -> Compilation_unit.t

val is_predefined_exception : Flambda2_identifiers.Symbol.t -> bool

Module Flambda2_identifiers.Symbol

Module `Flambda2_identifiers.Symbol`