Module `Core.String_id`Source

Like Identifiable, but with t = private string and stable modules.

include sig ... end

module type S = sig ... end

module type S_with_extras = sig ... end

include Core.String_id.S__local__portable

Sourcetype t = private Base.String.t

include sig ... end

include Bin_prot.Binable.S__local with type t := Core.String_id.t

include Ppx_compare_lib.Comparable.S with type t := Core.String_id.t

include Ppx_compare_lib.Equal.S with type t := Core.String_id.t

Sourceval globalize : Core.String_id.t @ local -> Core.String_id.t

include Ppx_hash_lib.Hashable.S_any with type t := Core.String_id.t

Sourceval t_sexp_grammar : Core.String_id.t Sexplib0.Sexp_grammar.t @@ portable

Sourceval sexp_of_t__stack : Core.String_id.t @ local -> Sexplib0.Sexp.t @ local

include Core.Identifiable.S__local__portable with type t := Core.String_id.t

val bin_size_t : Core.String_id.t Bin_prot.Size.sizer

val bin_write_t : Core.String_id.t Bin_prot.Write.writer

val bin_size_t__local : Core.String_id.t Bin_prot.Size.sizer__local

val bin_write_t__local : Core.String_id.t Bin_prot.Write.writer__local

val bin_read_t : Core.String_id.t Bin_prot.Read.reader

val __bin_read_t__ : Core.String_id.t Bin_prot.Read.vtag_reader

Sourceval bin_shape_t : Bin_prot.Shape.t

val bin_writer_t : Core.String_id.t Bin_prot.Type_class.writer

val bin_reader_t : Core.String_id.t Bin_prot.Type_class.reader

val bin_t : Core.String_id.t Bin_prot.Type_class.t

Sourceval t_of_sexp : Sexplib0.Sexp.t -> Core.String_id.t

Sourceval sexp_of_t : Core.String_id.t -> Sexplib0.Sexp.t

val pp : Base.Formatter.t -> Core.String_id.t -> unit

val (>=) : Core.String_id.t -> Core.String_id.t -> bool @@ portable

val (<=) : Core.String_id.t -> Core.String_id.t -> bool @@ portable

val (=) : Core.String_id.t -> Core.String_id.t -> bool @@ portable

val (>) : Core.String_id.t -> Core.String_id.t -> bool @@ portable

val (<) : Core.String_id.t -> Core.String_id.t -> bool @@ portable

val (<>) : Core.String_id.t -> Core.String_id.t -> bool @@ portable

val equal : Core.String_id.t -> Core.String_id.t -> bool @@ portable

val compare : Core.String_id.t -> Core.String_id.t -> int @@ portable

val equal__local : 
  Core.String_id.t @ local ->
  Core.String_id.t @ local ->
  bool @@ portable

val compare__local : 
  Core.String_id.t @ local ->
  Core.String_id.t @ local ->
  int @@ portable

val min : Core.String_id.t -> Core.String_id.t -> Core.String_id.t @@ portable

val max : Core.String_id.t -> Core.String_id.t -> Core.String_id.t @@ portable

val ascending : Core.String_id.t -> Core.String_id.t -> int @@ portable

val descending : Core.String_id.t -> Core.String_id.t -> int @@ portable

val between : 
  Core.String_id.t ->
  low:Core.String_id.t ->
  high:Core.String_id.t ->
  bool @@ portable

val clamp_exn : 
  Core.String_id.t ->
  min:Core.String_id.t ->
  max:Core.String_id.t ->
  Core.String_id.t @@ portable

val clamp : 
  Core.String_id.t ->
  min:Core.String_id.t ->
  max:Core.String_id.t ->
  Core.String_id.t Base.Or_error.t @@ portable

type comparator_witness

val validate_lbound : 
  min:Core.String_id.t Core.Maybe_bound.t ->
  Core.String_id.t Validate.check

val validate_ubound : 
  max:Core.String_id.t Core.Maybe_bound.t ->
  Core.String_id.t Validate.check

val validate_bound : 
  min:Core.String_id.t Core.Maybe_bound.t ->
  max:Core.String_id.t Core.Maybe_bound.t ->
  Core.String_id.t Validate.check

Sourcemodule Replace_polymorphic_compare : sig ... end

val comparator : 
  (Core.String_id.t, Core.String_id.comparator_witness)
    Base.Comparator.T.comparator

Sourcemodule Map : sig ... end

Sourcemodule Set : sig ... end

val hash_fold_t : Core.String_id.t Ppx_hash_lib.hash_fold

val hash : Core.String_id.t -> Ppx_hash_lib.Std.Hash.hash_value

val hashable : Core.String_id.t Base.Hashable.t

Sourcemodule Table : sig ... end

Sourcemodule Hash_set : sig ... end

Sourcemodule Hash_queue : sig ... end

include Base.Stringable.S__stack with type t := Core.String_id.t

Sourceval of_string : string -> Core.String_id.t

Sourceval to_string : Core.String_id.t -> string

include Core.Quickcheckable.S with type t := Core.String_id.t

Sourceval quickcheck_generator : Core.String_id.t Base_quickcheck.Generator.t

Sourceval quickcheck_observer : Core.String_id.t Base_quickcheck.Observer.t

Sourceval quickcheck_shrinker : Core.String_id.t Base_quickcheck.Shrinker.t

include Diffable.S_atomic with type t := Core.String_id.t

module Diff : sig ... end

Sourceval arg_type : Core.String_id.t Command.Arg_type.t

Sourcemodule Stable : sig ... end

Sourcemodule Make (M : sig ... end) () : sig ... end

Make customizes the error messages generated by of_string/of_sexp to include module_name. It also registers a pretty printer.

Sourcemodule Make_with_distinct_bin_shape (M : sig ... end) () : sig ... end

Like Make, but lets you specify a caller_identity to ensure that the bin-shape is distinct, which helps catch serialization bugs where identifiers with different meanings get confused with each other.

Sourcemodule Make_with_validate (M : sig ... end) () : sig ... end

Make_with_validate is like Make, but modifies of_string/of_sexp/bin_read_t to raise if validate returns an error. Before using this functor one should be mindful of the performance implications (the validate function will run every time an instance is created) as well as potential versioning issues (when validate changes old binaries still run the old version of the function).

Source

module Make_with_validate_and_distinct_bin_shape
  (M : sig ... end)
  () : 
  sig ... end

See Make_with_validate and Make_with_distinct_bin_shape

Sourcemodule Make_without_pretty_printer (M : sig ... end) () : sig ... end

This does what Make does without registering a pretty printer. Use this when the module that is made is not exposed in mli. Registering a pretty printer without exposing it causes an error in utop.

Source

module Make_with_validate_without_pretty_printer
  (M : sig ... end)
  () : 
  sig ... end

See Make_with_validate and Make_without_pretty_printer

Source

module String_without_validation_without_pretty_printer : 
  Core.String_id.S_with_extras__local__portable with type t = Base.String.t

Source

val make : 
  ?validate:(Base.String.t -> Base.Unit.t Core.Or_error.t) ->
  ?caller_identity:Bin_prot.Shape.Uuid.t ->
  ?include_pretty_printer:Base.Bool.t ->
  module_name:Base.String.t ->
  include_default_validation:Base.Bool.t ->
  Base.Unit.t ->
  (module Core.String_id.S_with_extras__local)

Module Core.String_idSource

Module `Core.String_id`Source