djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/ustruct: Document pack_into(), unpack_from().

This commit is contained in:
Paul Sokolovsky 2016-05-01 13:17:07 +03:00
parent d46cd02d95
commit 6b6acc5b5d
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/library/ustruct.rst
View File

@ -19,7 +19,19 @@ Functions
Pack the values ``v1``, ``v2``, ... according to the format string ``fmt``. Pack the values ``v1``, ``v2``, ... according to the format string ``fmt``.
The return value is a bytes object encoding the values. The return value is a bytes object encoding the values.
.. function:: pack_into(fmt, buffer, offset, v1, v2, ...)
Pack the values `v1`, `v2`, ... according to the format string `fmt`
into a `buffer` starting at `offset`. `offset` may be negative to count
from the end of `buffer`.
.. function:: unpack(fmt, data) .. function:: unpack(fmt, data)
Unpack from the ``data`` according to the format string ``fmt``. Unpack from the ``data`` according to the format string ``fmt``.
The return value is a tuple of the unpacked values. The return value is a tuple of the unpacked values.
.. function:: unpack_from(fmt, data, offset=0)
Unpack from the `data` starting at `offset` according to the format string
`fmt`. `offset` may be negative to count from the end of `buffer`. The return
value is a tuple of the unpacked values.