Append and consume bytes using only no-copy operations
About
A class that lets you do operations over a list of Uint8Arrays without
copying them.
import { Uint8ArrayList } from 'uint8arraylist'const list = new Uint8ArrayList()list.append(Uint8Array.from([0, 1, 2]))list.append(Uint8Array.from([3, 4, 5]))list.subarray()// -> Uint8Array([0, 1, 2, 3, 4, 5])list.consume(3)list.subarray()// -> Uint8Array([3, 4, 5])// you can also iterate over the listfor (const buf of list) { // ..do something with `buf`
Converting Uint8ArrayLists to Uint8Arrays
There are two ways to turn a Uint8ArrayList into a Uint8Array - .slice and .subarray and one way to turn a Uint8ArrayList into a Uint8ArrayList with different contents - .sublist.
slice
Slice follows the same semantics as Uint8Array.slice in that it creates a new Uint8Array and copies bytes into it using an optional offset & length.
const list = new Uint8ArrayList()list.append(Uint8Array.from([0, 1, 2]))list.append(Uint8Array.from([3, 4, 5]))list.slice(0, 1)// -> Uint8Array([0])
subarray
Subarray attempts to follow the same semantics as Uint8Array.subarray with one important different - this is a no-copy operation, unless the requested bytes span two internal buffers in which case it is a copy operation.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.