Add a section about byte/chunk stream naming
commit4e35d0da3d3dec009fe5a3ac9ce2ce9f147e7c29
authorHarendra Kumar <harendra@composewell.com>
dateTue 27 Jul 2021, 15:31 (5 years ago)
parent9603bb7
dev/container-api.md+7
@@ -7,6 +7,13 @@ module means converting the array to bytes, it sounds intuitive if read
77qualified with the module name e.g. Array.toBytes. This doc lists some
88conventions and guidelines to be followed.
99
10+## Bytes and Chunks
11+
12+APIs that deal with streams of Word8 may have "bytes" in their names
13+while the ones dealing with "Array Word8" have "chunks" in their
14+names. Usually the default is bytes when there is no explicit mention in
15+the name.
16+
1017## Unfolds and Folds
1118
1219* Unfolds are named as "read" or with a "read" prefix (e.g. readChunks).