diff options
author | Jim Mussared <jim.mussared@gmail.com> | 2021-08-12 13:56:13 +1000 |
---|---|---|
committer | Damien George <damien@micropython.org> | 2021-08-13 20:31:32 +1000 |
commit | 218606351c6f9688a3f90dad791bcb2109adcf1b (patch) | |
tree | de051ee21f5ccac3aaccfe3865ab5818f81fca37 /docs/library/struct.rst | |
parent | 671f012306e0942cbe59fcd43e25e67c289da351 (diff) | |
download | micropython-218606351c6f9688a3f90dad791bcb2109adcf1b.tar.gz micropython-218606351c6f9688a3f90dad791bcb2109adcf1b.zip |
docs: Rename ufoo.rst to foo.rst.
This is a simple rename of the files, no content changes
(other than updating index.rst to use the new paths)
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
Diffstat (limited to 'docs/library/struct.rst')
-rw-r--r-- | docs/library/struct.rst | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/library/struct.rst b/docs/library/struct.rst new file mode 100644 index 0000000000..bfcd84e2d8 --- /dev/null +++ b/docs/library/struct.rst @@ -0,0 +1,47 @@ +:mod:`ustruct` -- pack and unpack primitive data types +====================================================== + +.. module:: ustruct + :synopsis: pack and unpack primitive data types + +|see_cpython_module| :mod:`python:struct`. + +Supported size/byte order prefixes: ``@``, ``<``, ``>``, ``!``. + +Supported format codes: ``b``, ``B``, ``h``, ``H``, ``i``, ``I``, ``l``, +``L``, ``q``, ``Q``, ``s``, ``P``, ``f``, ``d`` (the latter 2 depending +on the floating-point support). + +.. admonition:: Difference to CPython + :class: attention + + Whitespace is not supported in format strings. + +Functions +--------- + +.. function:: calcsize(fmt) + + Return the number of bytes needed to store the given *fmt*. + +.. function:: pack(fmt, v1, v2, ...) + + Pack the values *v1*, *v2*, ... according to the format string *fmt*. + 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) + + Unpack from the *data* according to the format string *fmt*. + 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. |