diff options
| author | Dan Halbert <halbert@halwitz.org> | 2018-05-23 14:24:02 -0400 |
|---|---|---|
| committer | Dan Halbert <halbert@halwitz.org> | 2018-05-23 14:24:02 -0400 |
| commit | 079c20e58e2bb1ce8859cea99b951f6a3605e80b (patch) | |
| tree | 156bf71f5a5ac1e8b9d3b4d0d845382c5c6b2bea /docs | |
| parent | 20a13fa9fb1ed7b9e23aa9272132b97d7082cbd1 (diff) | |
use shared-bindings struct doc; remove docs/library one
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/index.rst | 1 | ||||
| -rw-r--r-- | docs/library/struct.rst | 44 |
2 files changed, 0 insertions, 45 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst index b14d7d2f8..6c2e576e7 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -46,7 +46,6 @@ Not all of these are enabled on all WiFi-capable ports. collections.rst gc.rst hashlib.rst - struct.rst sys.rst uerrno.rst uio.rst diff --git a/docs/library/struct.rst b/docs/library/struct.rst deleted file mode 100644 index bee5a612b..000000000 --- a/docs/library/struct.rst +++ /dev/null @@ -1,44 +0,0 @@ -:mod:`struct` -- pack and unpack primitive data types -====================================================== - -.. include:: ../templates/unsupported_in_circuitpython.inc - -.. module:: struct - :synopsis: pack and unpack primitive data types - -|see_cpython_module| :mod:`cpython: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). - -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. |