File: index.rst

package info (click to toggle)
bitstruct 8.21.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 320 kB
  • sloc: ansic: 2,649; python: 1,510; makefile: 165
file content (44 lines) | stat: -rw-r--r-- 1,367 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
.. bitstruct documentation master file, created by
   sphinx-quickstart on Sat Apr 25 11:54:09 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
   :maxdepth: 2

bitstruct - Interpret strings as packed binary data
===================================================

.. include:: ../README.rst

Functions
=========

.. autofunction:: bitstruct.pack
.. autofunction:: bitstruct.unpack
.. autofunction:: bitstruct.pack_into
.. autofunction:: bitstruct.unpack_from
.. autofunction:: bitstruct.pack_dict
.. autofunction:: bitstruct.unpack_dict
.. autofunction:: bitstruct.pack_into_dict
.. autofunction:: bitstruct.unpack_from_dict
.. autofunction:: bitstruct.calcsize
.. autofunction:: bitstruct.byteswap
.. autofunction:: bitstruct.compile

Classes
=======

.. autoclass:: bitstruct.CompiledFormat

   .. automethod:: bitstruct.CompiledFormat.pack
   .. automethod:: bitstruct.CompiledFormat.unpack
   .. automethod:: bitstruct.CompiledFormat.pack_into
   .. automethod:: bitstruct.CompiledFormat.unpack_from

.. autoclass:: bitstruct.CompiledFormatDict

   .. automethod:: bitstruct.CompiledFormatDict.pack
   .. automethod:: bitstruct.CompiledFormatDict.unpack
   .. automethod:: bitstruct.CompiledFormatDict.pack_into
   .. automethod:: bitstruct.CompiledFormatDict.unpack_from