package base

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

Creates a new empty dictionary.

val of_alist : (('key * 'data) list -> [ `Ok of ('key, 'data, 'phantom) t | `Duplicate_key of 'key ], 'key, 'data, 'phantom) 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, 'phantom) t | `Duplicate_keys of 'key list ], 'key, 'data, 'phantom) 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, 'phantom) t Or_error.t, 'key, 'data, 'phantom) creator

Like of_alist. Returns a Result.t.

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

Like of_alist. Raises on duplicates.

val of_alist_multi : (('key * 'data) list -> ('key, 'data list, 'phantom) t, 'key, 'data list, 'phantom) 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, 'phantom) t | `Duplicate_keys of 'key list ], 'key, 'data, 'phantom) 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, 'phantom) t | `Duplicate_keys of 'key list ], 'key, 'data, 'phantom) 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, 'phantom) t Or_error.t, 'key, 'data, 'phantom) 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, 'phantom) t, 'key, 'data, 'phantom) 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, 'phantom) t, 'key, 'data, 'phantom) creator

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

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events Blog Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct