package batteries
Install
Dune Dependency
Authors
Maintainers
Sources
md5=ea26b5c72e6731e59d856626049cca4d
sha512=55975b62c26f6db77433a3ac31f97af609fc6789bb62ac38b267249c78fd44ff37fe81901f1cf560857b9493a6046dd37b0d1c0234c66bd59e52843aac3ce6cb
doc/batteries.unthreaded/BatBuffer/index.html
Module BatBufferSource
Extensible string buffers.
This module implements string buffers that automatically expand as necessary. It provides accumulative concatenation of strings in quasi-linear time (instead of quadratic time when strings are concatenated pairwise).
create n returns a fresh buffer, initially empty. The n parameter is the initial size of the internal string that holds the buffer contents. That string is automatically reallocated when more than n characters are stored in the buffer, but shrinks back to n characters when reset 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, take n = 16 for instance. If n is not between 1 and Sys.max_string_length, it will be clipped to that interval.
Return a copy of the current contents of the buffer. The buffer itself is unchanged.
Return a copy of the current contents of the buffer. The buffer itself is unchanged.
Buffer.sub b off len returns a copy of len bytes from the current contents of the buffer b, starting at offset off.
Raise Invalid_argument if srcoff and len do not designate a valid range of b.
Buffer.blit src srcoff dst dstoff len copies len characters from the current contents of the buffer src, starting at offset srcoff to string dst, starting at character dstoff.
Empty the buffer and deallocate the internal string holding the buffer contents, replacing it with the initial internal string of length n that was allocated by Buffer.create n. For long-lived buffers that may have grown a lot, reset allows faster reclamation of the space used by the buffer.
add_char b c appends the character c at the end of the buffer b.
add_string b s appends the string s at the end of the buffer b.
add_bytes b s appends the string s at the end of the buffer b.
add_substring b s ofs len takes len characters from offset ofs in string s and appends them at the end of the buffer b.
add_subbytes b s ofs len takes len characters from offset ofs in byte sequence s and appends them at the end of the buffer b.
add_substitute b f s appends the string pattern s at the end of the buffer b with substitution. The substitution process looks for variables into the pattern and substitutes each variable name by its value, as obtained by applying the mapping f to the variable name. Inside the string pattern, a variable name immediately follows a non-escaped $ character and is one of the following:
- a non empty sequence of alphanumeric or
_characters, - an arbitrary sequence of characters enclosed by a pair of matching parentheses or curly brackets. An escaped
$character is a$that immediately follows a backslash character; it then stands for a plain$.
add_buffer b1 b2 appends the current contents of buffer b2 at the end of buffer b1. b2 is not modified.
add_input b ic n reads exactly n character from the input ic and stores them at the end of buffer b.
output_buffer b creates an output channel that writes to that buffer, and when closed, returns the contents of the buffer.
truncate b len truncates the length of b to len Note: the internal byte sequence is not shortened. Raises Invalid_argument if len < 0 or len > length b.
add_utf_8_uchar b u appends the UTF-8 encoding of u at the end of buffer b.
add_utf_16le_uchar b u appends the UTF-16LE encoding of u at the end of buffer b.
add_utf_16be_uchar b u appends the UTF-16BE encoding of u at the end of buffer b.
Boilerplate code
Iterators
Iterate on the buffer, in increasing order. Modification of the buffer during iteration is undefined behavior.
Iterate on the buffer, in increasing order, yielding indices along chars. Modification of the buffer during iteration is undefined behavior.
Binary encoding of integers
The functions in this section append binary encodings of integers to buffers.
Little-endian (resp. big-endian) encoding means that least (resp. most) significant bytes are stored first. Big-endian is also known as network byte order. Native-endian encoding is either little-endian or big-endian depending on Sys.big_endian.
32-bit and 64-bit integers are represented by the int32 and int64 types, which can be interpreted either as signed or unsigned numbers.
8-bit and 16-bit integers are represented by the int type, which has more bits than the binary encoding. Functions that encode these values truncate their inputs to their least significant bytes.
add_uint16_ne b i appends a binary native-endian unsigned 16-bit integer i to b.
add_uint16_be b i appends a binary big-endian unsigned 16-bit integer i to b.
add_uint16_le b i appends a binary little-endian unsigned 16-bit integer i to b.
add_int16_ne b i appends a binary native-endian signed 16-bit integer i to b.
add_int16_be b i appends a binary big-endian signed 16-bit integer i to b.
add_int16_le b i appends a binary little-endian signed 16-bit integer i to b.
add_int32_ne b i appends a binary native-endian 32-bit integer i to b.
add_int32_be b i appends a binary big-endian 32-bit integer i to b.
add_int32_le b i appends a binary little-endian 32-bit integer i to b.
add_int64_ne b i appends a binary native-endian 64-bit integer i to b.
add_int64_be b i appends a binary big-endian 64-bit integer i to b.