/usr/lib/ocaml/mm/ringbuffer.mli is in libmm-ocaml-dev 0.2.0-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | (*
* Copyright 2011 The Savonet Team
*
* This file is part of ocaml-mm.
*
* ocaml-mm is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* ocaml-mm is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with ocaml-mm; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* As a special exception to the GNU Library General Public License, you may
* link, statically or dynamically, a "work that uses the Library" with a publicly
* distributed version of the Library to produce an executable file containing
* portions of the Library, and distribute that executable file under terms of
* your choice, without any of the additional requirements listed in clause 6
* of the GNU Library General Public License.
* By "a publicly distributed version of the Library", we mean either the unmodified
* Library as distributed by The Savonet Team, or a modified version of the Library that is
* distributed under the conditions defined in clause 3 of the GNU Library General
* Public License. This exception does not however invalidate any other reasons why
* the executable file might be covered by the GNU Library General Public License.
*
*)
(** Operations on ringbuffers. *)
(** Signature for modules describing elements of ringbuffers (used by functors
creating ringbuffers). *)
module type Elt = sig
(** Type of an element. *)
type t
(** Generate an element. *)
val create : unit -> t
(** Blitting function. [Array.blit] should be used in most cases unless some
optimizations are required. *)
val blit : t array -> int -> t array -> int -> int -> unit
end
(** Signature for ringbuffer modules. *)
module type R = sig
(** Type of elements contained in the ringbuffer. *)
type elt
(** A buffer of elements. *)
type buffer = elt array
(** A ringbuffer. *)
type t
(** Create a ringbuffer of given size. *)
val create : int -> t
(** Size of data available for reading. *)
val read_space : t -> int
(** Size of space available for writing. *)
val write_space : t -> int
(** Drop data. *)
val read_advance : t -> int -> unit
(** Advance the write pointer. *)
val write_advance : t -> int -> unit
(** Read data. *)
val read : t -> buffer -> int -> int -> unit
(** Same as [read] but does not advance the read pointer. *)
val peek : t -> buffer -> int -> int -> unit
(** Write data. *)
val write : t -> buffer -> int -> int -> unit
(** Read all the data in the ringbuffer. *)
val transmit : t -> (buffer -> int -> int -> int) -> int
end
(** Create a ringbuffer. *)
module Make : functor (E:Elt) -> R with type elt = E.t
(** Create an extensible ringbuffer: the size of the ringbuffer is extended if
write space is too small at some point. *)
module Make_ext : functor (E:Elt) -> R with type elt = E.t
|