Buffer Module

(buffer/bit buf bit-index)

Gets the bit at `bit-index` in a buffer, `buf`. Returns true if the bit is set, false if not.

(buffer/bit-clear buf bit-index)

Clears the bit at `bit-index` in a buffer, `buf`. Returns `buf`.

(buffer/bit-set buf bit-index)

Sets the bit at `bit-index` in a buffer, `buf`. Returns `buf`.

(buffer/bit-toggle buf bit-index)

Toggles the bit at `bit-index` in a buffer, `buf`. Returns `buf`.

(buffer/blit dest src &opt dest-start src-start src-end)

Insert the contents of `src` into `dest`. Can optionally take indices that indicate which part of `src` to copy into which part of `dest`. Indices can be negative in order to index from the end of `src` or `dest`. Returns `dest`.

(buffer/clear buf)

Sets the size of a buffer, `buf`, to 0 and empties it. `buf` retains its memory so it can be efficiently refilled. Returns `buf`.

(buffer/fill buf &opt byte)

Fill up a buffer, `buf`, with bytes, defaulting to 0s. Does not change `buf`'s length. Returns `buf`.

(buffer/format buf fmt & args)

Formats `fmt`, similar to `sprintf()`, with `args` into a buffer `buf`. Returns buf.

(buffer/format-at buf at fmt & args)

Formats `fmt`, similar to `sprintf()`, with `args` into a buffer `buf`, starting at index `at`. Returns buf.

(buffer/from-bytes & byte-vals)

Creates a buffer from integer parameters with byte values. All integers will be coerced to the range of 1 byte 0-255.

(buffer/new capacity)

Creates a new, empty buffer with enough backing memory for `capacity` bytes. Returns a new buffer of length 0.

(buffer/new-filled n &opt byte)

Creates a new buffer of length `n` filled up with `byte`. By default, `byte` is 0. Returns the new buffer.

(buffer/popn buf n)

Removes the last `n` bytes from a buffer, `buf`. Returns `buf`.

(buffer/push buf & xs)

Push both single bytes and bytes type values to a buffer, `buf`. Values in `xs` that are bytes are pushed to `buf` as bytes, while bytes type values have their individual bytes pushed. Thus, this function behaves like both `buffer/push-byte` and `buffer/push-string`. Returns `buf`. Expands `buf` as needed. Throws an error if size limit is exceeded.

(buffer/push-at buf index & xs)

Same as `buffer/push`, but copies the new data into `buf` at index `index`.

(buffer/push-byte buf & xs)

Append bytes to a buffer, `buf`. Returns `buf`. Expands `buf` as needed. Throws an error if size limit is exceeded.

(buffer/push-float32 buf order data)

Push the underlying bytes of a 32 bit float, `data`, onto the end of the buffer, `buf`. Returns `buf`. Expands `buf` as needed. Throws an error if size limit is exceeded.

(buffer/push-float64 buf order data)

Push the underlying bytes of a 64 bit float, `data`, onto the end of the buffer, `buf`. Returns `buf`. Expands `buf` as needed. Throws an error if size limit is exceeded.

(buffer/push-string buf & xs)

Push bytes type values onto the end of a buffer, `buf`. Each `xs` should be a bytes type. Returns `buf`. Expands `buf` as needed. Throws an error if size limit is exceeded.

(buffer/push-uint16 buf order data)

Push a 16 bit unsigned integer, `data`, onto the end of a buffer, `buf`. Returns `buf`. Expands `buf` as needed. Throws an error if size limit is exceeded.

(buffer/push-uint32 buf order data)

Push a 32 bit unsigned integer, `data` onto the end of a buffer, `buf`. Returns `buf`. Expands `buf` as needed. Throws an error if size limit is exceeded.

(buffer/push-uint64 buf order data)

Push a 64 bit unsigned integer, `data`, onto the end of a buffer, `buf`. Returns `buf`. Expands `buf` as needed. Throws an error if size limit is exceeded.

(buffer/push-word buf & xs)

Append machine words to a buffer, `buf`. The 4 bytes of the integer are appended in two's complement, little endian order, unsigned for all x. Returns `buf`. Expands `buf` as needed. Throws an error if size limit is exceeded.

(buffer/slice bytes &opt start end)

Same as `string/slice`, but returns a buffer.

(buffer/trim buf)

Set the backing capacity of a buffer, `buf`, to its current length. Returns `buf`.