composewell/streamly
1
1
Fork 0
mirror of https://github.com/composewell/streamly.git synced 2024-10-27 12:12:05 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add a section about byte/chunk stream naming

Browse Source
This commit is contained in:
Harendra Kumar 2021-07-27 15:31:48 +05:30
parent 9603bb753f
commit 4e35d0da3d
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
dev/container-api.md
View File

@ -7,6 +7,13 @@ module means converting the array to bytes, it sounds intuitive if read
qualified with the module name e.g. Array.toBytes. This doc lists some
conventions and guidelines to be followed.
## Bytes and Chunks
APIs that deal with streams of Word8 may have "bytes" in their names
while the ones dealing with "Array Word8" have "chunks" in their
names. Usually the default is bytes when there is no explicit mention in
the name.
## Unfolds and Folds
* Unfolds are named as "read" or with a "read" prefix (e.g. readChunks).