package base

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type ('key, 'data) t
type ('fn, 'key, 'data) creator
val create : (unit -> ('key, 'data) t, 'key, 'data) creator

Creates a new empty dictionary.

val of_alist : (('key * 'data) list -> [ `Ok of ('key, 'data) t | `Duplicate_key of 'key ], 'key, 'data) creator

Dictionary containing the given key/value pairs. Fails if there are duplicate keys.

val of_alist_report_all_dups : (('key * 'data) list -> [ `Ok of ('key, 'data) t | `Duplicate_keys of 'key list ], 'key, 'data) creator

Like of_alist. On failure, provides all duplicate keys instead of a single representative.

val of_alist_or_error : (('key * 'data) list -> ('key, 'data) t Or_error.t, 'key, 'data) creator

Like of_alist. Returns a Result.t.

val of_alist_exn : (('key * 'data) list -> ('key, 'data) t, 'key, 'data) creator

Like of_alist. Raises on duplicates.

val of_alist_multi : (('key * 'data) list -> ('key, 'data list) t, 'key, 'data list) creator

Produces a dictionary mapping each key to a list of associated values.

val create_mapped : (get_key:('a -> 'key) -> get_data:('a -> 'data) -> 'a list -> [ `Ok of ('key, 'data) t | `Duplicate_keys of 'key list ], 'key, 'data) creator

Like of_alist. Consume a list of elements for which key/value pairs can be computed.

val create_with_key : (get_key:('data -> 'key) -> 'data list -> [ `Ok of ('key, 'data) t | `Duplicate_keys of 'key list ], 'key, 'data) creator

Like of_alist. Consume values for which keys can be computed.

val create_with_key_or_error : (get_key:('data -> 'key) -> 'data list -> ('key, 'data) t Or_error.t, 'key, 'data) creator

Like of_alist_or_error. Consume values for which keys can be computed.

val create_with_key_exn : (get_key:('data -> 'key) -> 'data list -> ('key, 'data) t, 'key, 'data) creator

Like of_alist_exn. Consume values for which keys can be computed.

val group : (get_key:('a -> 'key) -> get_data:('a -> 'data) -> combine:('data -> 'data -> 'data) -> 'a list -> ('key, 'data) t, 'key, 'data) creator

Like create_mapped. Multiple values for a key are combined rather than producing an error.

OCaml

Innovation. Community. Security.