package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file hash_queue.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2022 Nomadic Labs, <contact@nomadic-labs.com>               *)
(*                                                                           *)
(* Permission is hereby granted, free of charge, to any person obtaining a   *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense,  *)
(* and/or sell copies of the Software, and to permit persons to whom the     *)
(* Software is furnished to do so, subject to the following conditions:      *)
(*                                                                           *)
(* The above copyright notice and this permission notice shall be included   *)
(* in all copies or substantial portions of the Software.                    *)
(*                                                                           *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL   *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING   *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER       *)
(* DEALINGS IN THE SOFTWARE.                                                 *)
(*                                                                           *)
(*****************************************************************************)

module Make
    (K : Hashtbl.HashedType) (V : sig
      type t
    end) =
struct
  module Cache =
    Aches.Vache.Map (Aches.Vache.FIFO_Precise) (Aches.Vache.Strong) (K)
  include Cache

  type nonrec t = V.t t

  let elements q = Cache.fold (fun _ x acc -> x :: acc) q []

  let keys q = Cache.fold (fun k _ acc -> k :: acc) q []

  let bindings q = Cache.fold (fun k x acc -> (k, x) :: acc) q []

  (** [oldest_elements q n f] returns the (at most) [n] oldest elements of the
      queue and calls [f] on the bindings for these elements. The elements are
      returned from oldest to newest. *)
  let oldest_elements q n action =
    let exception Elements of V.t list in
    let rev_elts =
      try
        Cache.fold_oldest_first
          (fun k v (count, acc) ->
            if count >= n then raise (Elements acc)
            else (
              action k v q ;
              (count + 1, v :: acc)))
          q
          (0, [])
        |> snd
      with Elements acc -> acc
    in
    List.rev rev_elts

  (* Redefining fold to have elements treated in order of oldest to newest *)
  let fold f q acc = Cache.fold_oldest_first f q acc

  let fold_s f q acc =
    let open Lwt.Syntax in
    fold
      (fun k v acc ->
        let* acc in
        f k v acc)
      q
      (Lwt.return acc)

  let fold_es (type error) f q acc : (_, error) result Lwt.t =
    let open Lwt.Syntax in
    let exception Error of error in
    Lwt.try_bind
      (fun () ->
        fold_s
          (fun k v acc ->
            let* res = f k v acc in
            match res with
            | Ok acc -> Lwt.return acc
            | Error e -> Lwt.fail (Error e))
          q
          acc)
      Lwt.return_ok
      (function Error e -> Lwt.return_error e | e -> Lwt.reraise e)

  let peek q =
    match oldest_elements q 1 (fun _ _ _ -> ()) with
    | [] -> None
    | [x] -> Some x
    | _ -> assert false

  let take q =
    match oldest_elements q 1 (fun k _ q -> remove q k) with
    | [] -> None
    | [x] -> Some x
    | _ -> assert false

  let peek_at_most q n = oldest_elements q n (fun _ _ _ -> ())

  let take_at_most q n =
    (* Removing the keys during the fold does not work, accumulating the keys
       then removing them does the trick. *)
    let keys = ref [] in
    let values = oldest_elements q n (fun k _ _ -> keys := k :: !keys) in
    List.iter (remove q) !keys ;
    values
end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet 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