Skip to content

Commit 8a421d5

Browse files
committed
README: Note that encode & decode functions don't do framing & deframing
GitHub issue #4.
1 parent 8a26e66 commit 8a421d5

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,14 @@ bytes, is also acceptable as input::
131131
>>> cobs.decode(encoded)
132132
b'Hello world\x00This is a test'
133133

134+
Note that the ``encode`` function does not add any framing ``0x00`` byte at
135+
the end (or beginning) of the encoded data. Similarly, the ``decode`` function
136+
does not strip or split on any framing ``0x00`` bytes, but treats any ``0x00``
137+
bytes as a data input error. The details of data framing is
138+
application-specific, so it is the user's application's responsibility to
139+
implement the framing and deframing that is suitable for the needs of the
140+
application.
141+
134142

135143
-------------------------
136144
Supported Python Versions

0 commit comments

Comments
 (0)