Source file stdcompat__queue_s.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
module type S = sig

type !'a t = 'a Queue.t

(*
type 'a t = 'a Queue.t
*)

(** Alias for {!Queue.t} *)

exception Empty 
(** Alias for {!Queue.Empty} *)

val take_opt : 'a t -> 'a option
(** @since 4.08.0: val take_opt : 'a t -> 'a option *)

val peek_opt : 'a t -> 'a option
(** @since 4.08.0: val peek_opt : 'a t -> 'a option *)


val to_seq : 'a t -> 'a Seq.t

(*
val to_seq : 'a t -> 'a Stdcompat__seq.t
*)
(** @since 4.07.0: val to_seq : 'a t -> 'a Seq.t
 *)


val add_seq : 'a t -> 'a Seq.t -> unit

(*
val add_seq : 'a t -> 'a Stdcompat__seq.t -> unit
*)
(** @since 4.07.0: val add_seq : 'a t -> 'a Seq.t -> unit
 *)


val of_seq : 'a Seq.t -> 'a t

(*
val of_seq : 'a Stdcompat__seq.t -> 'a t
*)
(** @since 4.07.0: val of_seq : 'a Seq.t -> 'a t
 *)

val create : unit -> 'a t
(** Alias for {!Queue.create} *)

val add : 'a -> 'a t -> unit
(** Alias for {!Queue.add} *)

val push : 'a -> 'a t -> unit
(** Alias for {!Queue.push} *)

val take : 'a t -> 'a
(** Alias for {!Queue.take} *)

val pop : 'a t -> 'a
(** Alias for {!Queue.pop} *)

val peek : 'a t -> 'a
(** Alias for {!Queue.peek} *)

val top : 'a t -> 'a
(** Alias for {!Queue.top} *)

val clear : 'a t -> unit
(** Alias for {!Queue.clear} *)

val copy : 'a t -> 'a t
(** Alias for {!Queue.copy} *)

val is_empty : 'a t -> bool
(** Alias for {!Queue.is_empty} *)

val length : 'a t -> int
(** Alias for {!Queue.length} *)

val iter : ('a -> unit) -> 'a t -> unit
(** Alias for {!Queue.iter} *)


val fold : ('acc -> 'a -> 'acc) -> 'acc -> 'a t -> 'acc

(*

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

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

*)
(** @since 5.1.0: val fold : ('acc -> 'a -> 'acc) -> 'acc -> 'a t -> 'acc
@since 4.00.0: val fold : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b
@since 3.07.0: val fold : ('a -> 'b -> 'a) -> 'a -> 'b t -> 'a
 *)

val transfer : 'a t -> 'a t -> unit
(** Alias for {!Queue.transfer} *)

val drop : 'a t -> unit

end