package datakit-github

You can search for identifiers within the package.

in-package search v0.2.0

datakit-github
- Datakit_github
  - API
    
    Webhook
  - Capabilities
  - Commit
    
    Set
  - Diff
  - ELT
  - Elt
    
    IdSet
    
    Set
  - Event
  - MAP
  - PR
    
    IdSet
    
    Index
    
    Set
  - Ref
    
    IdSet
    
    Index
    
    Set
  - Repo
    
    Map
    
    Set
  - SET
  - Set
    
    E
  - Snapshot
  - Status
    
    Index
    
    Set
  - Status_state
- Datakit_github_conv
  - Make
    
    DK
    
    Branch
    
    Commit
    
    Transaction
    
    Tree

Legend:
Library
Module
Module type
Parameter
Class
Class type

Maps indexed by build status IDs.

include Asetmap.Map.S with type key = id

Map

include Map.S with type key = id

type key = id

The type of the map keys.

type +'a t

The type of maps from type key to type 'a.

val empty : 'a t

The empty map.

val is_empty : 'a t -> bool

Test whether a map is empty or not.

val mem : key -> 'a t -> bool

mem x m returns true if m contains a binding for x, and false otherwise.

val add : key -> 'a -> 'a t -> 'a t

add x y m returns a map containing the same bindings as m, plus a binding of x to y. If x was already bound in m to a value that is physically equal to y, m is returned unchanged (the result of the function is then physically equal to m). Otherwise, the previous binding of x in m disappears.

before 4.03
Physical equality was not ensured.

val singleton : key -> 'a -> 'a t

singleton x y returns the one-element map that contains a binding y for x.

since 3.12.0

val remove : key -> 'a t -> 'a t

remove x m returns a map containing the same bindings as m, except for x which is unbound in the returned map. If x was not in m, m is returned unchanged (the result of the function is then physically equal to m).

before 4.03
Physical equality was not ensured.

val merge : 
  (key -> 'a option -> 'b option -> 'c option) ->
  'a t ->
  'b t ->
  'c t

merge f m1 m2 computes a map whose keys is a subset of keys of m1 and of m2. The presence of each such binding, and the corresponding value, is determined with the function f.

since 3.12.0

val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t

union f m1 m2 computes a map whose keys is the union of keys of m1 and of m2. When the same binding is defined in both arguments, the function f is used to combine them.

since 4.03.0

val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int

Total ordering between maps. The first argument is a total ordering used to compare data associated with equal keys in the two maps.

val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool

equal cmp m1 m2 tests whether the maps m1 and m2 are equal, that is, contain equal keys and associate them with equal data. cmp is the equality predicate used to compare the data associated with the keys.

val iter : (key -> 'a -> unit) -> 'a t -> unit

iter f m applies f to all bindings in map m. f receives the key as first argument, and the associated value as second argument. The bindings are passed to f in increasing order with respect to the ordering over the type of the keys.

val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b

fold f m a computes (f kN dN ... (f k1 d1 a)...), where k1 ... kN are the keys of all bindings in m (in increasing order), and d1 ... dN are the associated data.

val for_all : (key -> 'a -> bool) -> 'a t -> bool

for_all p m checks if all the bindings of the map satisfy the predicate p.

since 3.12.0

val exists : (key -> 'a -> bool) -> 'a t -> bool

exists p m checks if at least one binding of the map satisfies the predicate p.

since 3.12.0

val filter : (key -> 'a -> bool) -> 'a t -> 'a t

filter p m returns the map with all the bindings in m that satisfy predicate p. If p satisfies every binding in m, m is returned unchanged (the result of the function is then physically equal to m)

since 3.12.0

before 4.03
Physical equality was not ensured.

val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t

partition p m returns a pair of maps (m1, m2), where m1 contains all the bindings of s that satisfy the predicate p, and m2 is the map with all the bindings of s that do not satisfy p.

since 3.12.0

val cardinal : 'a t -> int

Return the number of bindings of a map.

since 3.12.0

val bindings : 'a t -> (key * 'a) list

Return the list of all bindings of the given map. The returned list is sorted in increasing order with respect to the ordering Ord.compare, where Ord is the argument given to Map.Make.

since 3.12.0

val split : key -> 'a t -> 'a t * 'a option * 'a t

split x m returns a triple (l, data, r), where l is the map with all the bindings of m whose key is strictly less than x; r is the map with all the bindings of m whose key is strictly greater than x; data is None if m contains no binding for x, or Some v if m binds v to x.

since 3.12.0

val map : ('a -> 'b) -> 'a t -> 'b t

map f m returns a map with same domain as m, where the associated value a of all bindings of m has been replaced by the result of the application of f to a. The bindings are passed to f in increasing order with respect to the ordering over the type of the keys.

val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t

Same as Map.S.map, but the function receives as arguments both the key and the associated value for each binding of the map.

val find : key -> 'a t -> 'a option

find k m is the binding of k in m (if any).

val get : key -> 'a t -> 'a

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

val min_binding : 'a t -> (key * 'a) option

min_binding m is the smallest binding of m (if any).

val get_min_binding : 'a t -> key * 'a

get_min_binding is like min_binding but

raises Invalid_argument
on the empty map.

val max_binding : 'a t -> (key * 'a) option

max_binding m is the greatest binding of m (if any).

val get_max_binding : 'a t -> key * 'a

get_min_binding is like max_binding but

raises Invalid_argument
on the empty map.

val choose : 'a t -> (key * 'a) option

choose m is a binding of m (if any). Equal bindings are chosen for equal maps.

val get_any_binding : 'a t -> key * 'a

get_any_binding is like choose but

raises Invalid_argument
on the empty map.

Conversions

val to_list : 'a t -> (key * 'a) list

to_list m is the bindings of m in increasing key order.

val of_list : (key * 'a) list -> 'a t

of_list l is the map holding the bindings of l. If a key is bound more than once the last one takes over.

Pretty-printing

val dump : 
  (Format.formatter -> (key * 'a) -> unit) ->
  Format.formatter ->
  'a t ->
  unit

dump pp_binding prints an unspecified represention of m on ppf using pp_binding to print the bindings.

val pp : 'a Fmt.t -> 'a t Fmt.t