Module type Buffer.S
val sexp_of_t : t -> Base.Sexp.t
val create : int -> t
create n
returns a fresh buffer, initially empty. Then
parameter is the initial size of the internal storage medium that holds the buffer contents. That storage is automatically reallocated when more thann
characters are stored in the buffer, but shrinks back ton
characters whenreset
is called.For best performance,
n
should be of the same order of magnitude as the number of characters that are expected to be stored in the buffer (for instance, 80 for a buffer that holds one output line). Nothing bad will happen if the buffer grows beyond that limit, however. In doubt, taken = 16
for instance.
val contents : t -> string
Return a copy of the current contents of the buffer. The buffer itself is unchanged.
val contents_bytes : t -> bytes
include Base.Blit.S_distinct with type src := t with type dst := bytes
val blit : (src, dst) Base__.Blit_intf.blit
val blito : (src, dst) Base__.Blit_intf.blito
val unsafe_blit : (src, dst) Base__.Blit_intf.blit
val sub : (src, dst) Base__.Blit_intf.sub
val subo : (src, dst) Base__.Blit_intf.subo
module To_string : Base.Blit.S_to_string with type t := t
val nth : t -> int -> char
Gets the (zero-based) n-th character of the buffer. Raises
Invalid_argument
if index out of bounds.
val length : t -> int
Returns the number of characters currently contained in the buffer.
val clear : t -> unit
Empties the buffer.
val reset : t -> unit
Empties the buffer and deallocates the internal storage holding the buffer contents, replacing it with the initial internal storage of length
n
that was allocated bycreate n
. For long-lived buffers that may have grown a lot,reset
allows faster reclamation of the space used by the buffer.
val add_char : t -> char -> unit
add_char b c
appends the characterc
at the end of the bufferb
.
val add_string : t -> string -> unit
add_string b s
appends the strings
at the end of the bufferb
.
val add_substring : t -> string -> pos:int -> len:int -> unit
add_substring b s pos len
takeslen
characters from offsetpos
in strings
and appends them at the end of the bufferb
.
val add_bytes : t -> bytes -> unit
add_bytes b s
appends the bytess
at the end of the bufferb
.
val add_subbytes : t -> bytes -> pos:int -> len:int -> unit
add_subbytes b s pos len
takeslen
characters from offsetpos
in bytess
and appends them at the end of the bufferb
.