summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/struct.rst
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2014-11-02 23:37:02 +0000
committerDamien George <damien.p.george@gmail.com>2014-11-02 23:37:02 +0000
commit6e6dfdc56be2a5d6476d087043d2a4ccae139af2 (patch)
treef63db0de4531eacf91fdc94ed34bc060c2439cef /docs/library/struct.rst
parent1060baa2c26d45c2641ee786581655eb44ffda90 (diff)
downloadmicropython-6e6dfdc56be2a5d6476d087043d2a4ccae139af2.tar.gz
micropython-6e6dfdc56be2a5d6476d087043d2a4ccae139af2.zip
docs: Make custom index page; add more docs.
Diffstat (limited to 'docs/library/struct.rst')
-rw-r--r--docs/library/struct.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/library/struct.rst b/docs/library/struct.rst
new file mode 100644
index 0000000000..71ee5c9b70
--- /dev/null
+++ b/docs/library/struct.rst
@@ -0,0 +1,25 @@
+:mod:`struct` -- pack and unpack primitive data types
+=====================================================
+
+.. module:: struct
+ :synopsis: pack and unpack primitive data types
+
+See `Python struct <https://docs.python.org/3/library/struct.html>`_ for more
+information.
+
+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:: unpack(fmt, data)
+
+ Unpack from the ``data`` according to the format string ``fmt``.
+ The return value is a tuple of the unpacked values.