summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/ustruct.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/ustruct.rst')
-rw-r--r--docs/library/ustruct.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/library/ustruct.rst b/docs/library/ustruct.rst
new file mode 100644
index 0000000000..f65d6058df
--- /dev/null
+++ b/docs/library/ustruct.rst
@@ -0,0 +1,25 @@
+:mod:`ustruct` -- pack and unpack primitive data types
+======================================================
+
+.. module:: ustruct
+ :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.