We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 8a26e66 commit 8a421d5Copy full SHA for 8a421d5
1 file changed
README.rst
@@ -131,6 +131,14 @@ bytes, is also acceptable as input::
131
>>> cobs.decode(encoded)
132
b'Hello world\x00This is a test'
133
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
+
142
143
-------------------------
144
Supported Python Versions
0 commit comments