Module Astring.String.Map

module Map: sig .. end

String maps.

String maps

include Map.S

val min_binding : 'a Astring.String.t -> (string * 'a) option

Exception safe Map.S.min_binding.

val get_min_binding : 'a Astring.String.t -> string * 'a

get_min_binding is like Astring.String.Map.min_binding but

Raises Invalid_argument on the empty map.

val max_binding : 'a Astring.String.t -> (string * 'a) option

Exception safe Map.S.max_binding.

val get_max_binding : 'a Astring.String.t -> string * 'a

get_max_binding is like Astring.String.Map.max_binding but

Raises Invalid_argument on the empty map.

val choose : 'a Astring.String.t -> (string * 'a) option

Exception safe Map.S.choose.

val get_any_binding : 'a Astring.String.t -> string * 'a

get_any_binding is like Astring.String.Map.choose but

Raises Invalid_argument on the empty map.

val find : string -> 'a Astring.String.t -> 'a option

Exception safe Map.S.find.

val get : string -> 'a Astring.String.t -> 'a

get k m is like Map.S.find but raises Invalid_argument if k is not bound in m.

val dom : 'a Astring.String.t -> Astring.String.set

dom m is the domain of m.

val of_list : (string * 'a) list -> 'a Astring.String.t

of_list bs is List.fold_left (fun m (k, v) -> add k v m) empty bs.

val of_stdlib_map : 'a Stdlib.Map.Make(Stdlib.String).t -> 'a Astring.String.t

of_stdlib_map m is a map from the stdlib-compatible map m.

val to_stdlib_map : 'a Astring.String.t -> 'a Stdlib.Map.Make(Stdlib.String).t

to_stdlib_map m is the stdlib-compatible map equivalent to m.

val pp : ?sep:(Stdlib.Format.formatter -> unit -> unit) ->
       (Stdlib.Format.formatter -> string * 'a -> unit) ->
       Stdlib.Format.formatter -> 'a Astring.String.t -> unit

pp ~sep pp_binding ppf m formats the bindings of m on ppf. Each binding is formatted with pp_binding and bindings are separated by sep (defaults to Format.pp_print_cut). If the map is empty leaves ppf untouched.

val dump : (Stdlib.Format.formatter -> 'a -> unit) ->
       Stdlib.Format.formatter -> 'a Astring.String.t -> unit

dump pp_v ppf m prints an unspecified representation of m on ppf using pp_v to print the map codomain elements.

val dump_string_map : Stdlib.Format.formatter -> string Astring.String.t -> unit

dump_string_map ppf m prints an unspecified representation of the string map m on ppf.