File: index.rst

package info (click to toggle)
construct 2.10.68%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, trixie
  • size: 1,812 kB
  • sloc: python: 11,793; makefile: 135
file content (110 lines) | stat: -rw-r--r-- 3,155 bytes parent folder | download | duplicates (2)
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
.. raw:: html

    <div style="float:right; margin:1em; padding: 1em 2em 1em 2em; background-color: #efefef;
        border-radius: 5px; border-width: thin; border-style: dotted; border-color: #0C3762;">
    <strong>Chapters</strong><br/>
    <ul>
    <li><a href="#user-guide" title="Jump to user guide">User Guide</a></li>
    <li><a href="#api-reference" title="Jump to API reference">API Reference</a></li>
    </ul>
    <strong>External links</strong><br/>
    <ul>
    <li><a href="https://github.com/construct/construct">Code repository</a></li>
    <li><a href="https://travis-ci.org/construct/construct/builds">Travis CI (deprecated)</a></li>
    <li><a href="https://github.com/construct/construct/issues">Questions on Issues</a></li>
    <li><a href="https://pypi.org/project/construct/">Downloads</a></li>
    </ul>
    <strong>Personal sites</strong><br/>
    <a href="https://arekbulski.github.io/" target="_blank">
    <img style="display: block; margin-left: auto; margin-right: auto"
    src="_static/arkadiusz-120.png" title="Arkadiusz'es personal site"/></a>
    <br/>
    <a href="http://tomerfiliba.com" target="_blank">
    <img style="display: block; margin-left: auto; margin-right: auto"
    src="_static/tomer-57.png" title="Tomer's Blog"/></a>
    <br/>
    <a href="https://corbinsimpson.com/" target="_blank">
    <img style="display: block; margin-left: auto; margin-right: auto"
    src="_static/corbin-100.png" title="Corbin's Blog"/></a>
    <br/>
    </div>


Construct
=========
.. raw:: html

    <div style="width:770px; margin: 1em 0 2em 0; display: block; padding: 1em; border: 1px dotted #DDD;
    background-color: rgba(255, 255, 202, 0.69); border-radius: 5px;">

    <strong>Sticky</strong><br/>
    <br/>

    <a class="reference external" href="https://github.com/construct/construct/releases">Version 2.10</a> was released in January 2020. It removes major neckpains (Embedded and EmbeddedSwitch). See Transition page.<br/>
    <br/>

    Happy to announce collaboration with <a class="reference external" href="http://kaitai.io/">Kaitai Struct</a>, a multi-platform binary parser. <br/>
    <br/>

    Please use <a class="reference external" href="https://github.com/construct/construct/issues">github issues</a> to ask general questions, make feature requests (and vote for them), report issues and bugs, and to submit PRs. Feel free to request any changes that would support your project.<br/>
    <br/>

    </div>


User Guide
==========

.. toctree::
   :maxdepth: 2

   intro
   transition28
   transition29
   transition210
   basics
   advanced
   bitwise
   meta
   misc
   streaming
   tunneling
   lazy
   adapters
   extending
   debugging
   compilation

API Reference
=============

.. toctree::
   :maxdepth: 2

   api/abstract
   api/exceptions
   api/bytes
   api/numerics
   api/strings
   api/mappings
   api/structs
   api/repeaters
   api/special
   api/misc
   api/conditional
   api/align
   api/streaming
   api/tunneling
   api/lazy
   api/debugging
   api/adapters

   api/core
   api/lib

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`