Previous  Up  Next

Module Cbuffer

module Cbuffer: sig .. end
Circular buffers.

THIS LIBRARY WILL BE DELETED IN FAVOUR OF DEQUEUE AT SOME POINT IN THE FUTURE

type 'a t = {
   mutable data :'a array;
   mutable start :int;
   mutable length :int;
   never_shrink :bool;
   dummy :'a;
} 
val create : ?never_shrink:bool -> 'a -> Core.Std.Int.t -> 'a t
val length : 'a t -> int
val phys_length : 'a t -> int
val is_full : 'a t -> bool
val check_index : string -> 'a t -> int -> unit
val get : 'a t -> int -> 'a
val set : 'a t -> int -> 'a -> unit
val copy_data : src:'a Core.Std.Array.t -> dst:'a Core.Std.Array.t -> int -> int -> unit
copies data from one array to another. This assumes that the destination array is large enough to accommodate the data
val swap_array : 'a t -> int -> unit
swap_array buf len copies the contents of buf to a new array of length len and places that new data into the buffer
val expand : 'a t -> unit
double the size of the buffer
val shrink : 'a t -> unit
half the size of the buffer
val to_array : 'a t -> 'a Core.Std.Array.t
val add : 'a t -> 'a -> unit
val drop_from : 'a t -> int -> unit
val drop_last : 'a t -> unit
val iter : 'a t -> f:(int -> 'a -> unit) -> unit
iter buf ~f calls func on each buffer element starting with 0 like this: (func pos element)
val iterr : 'a t -> f:(int -> 'a -> unit) -> unit
iterr buf ~f calls func on each buffer element starting with end like this: (func pos element)
val of_array : 'a Core.Std.Array.t -> 'a t
initialize Cbuffer from array
val cb_compare : f:('a -> 'b -> bool) ->
       b1:'a t -> b2:'b t -> s1:int -> s2:int -> n:int -> bool
compare two buffer fragments
val drop_old : ?cmp:('a -> 'a -> int) ->
       ?free:('b -> unit) -> f:('b -> 'a) -> cutoff:'a -> 'b t -> int
drop stuff from the end. equivalent to while cutoff > f (get buf (length buf - 1)) do drop_last buf; done but calls drop just once
val t_of_sexp : (Sexplib.Sexp.t -> 'a) -> Sexplib.Sexp.t -> 'a t
val sexp_of_t : ('a -> Sexplib.Sexp.t) -> 'a t -> Sexplib.Sexp.t

copies data from one array to another. This assumes that the destination array is large enough to accommodate the data

swap_array buf len copies the contents of buf to a new array of length len and places that new data into the buffer

double the size of the buffer

half the size of the buffer

iter buf ~f calls func on each buffer element starting with 0 like this: (func pos element)

iterr buf ~f calls func on each buffer element starting with end like this: (func pos element)

initialize Cbuffer from array

compare two buffer fragments

drop stuff from the end. equivalent to while cutoff > f (get buf (length buf - 1)) do drop_last buf; done but calls drop just once