Deployed 5bca4a1 with MkDocs version: 1.6.1

Author: andreax79

index.html

@@ -67,6 +67,8 @@
     </li>
     <li class="toctree-l3"><a class="reference internal" href="#define-sizeof-and-eval">Define, Sizeof, and Eval</a>
     </li>
+    <li class="toctree-l3"><a class="reference internal" href="#accessing-field-definitions">Accessing Field Definitions</a>
+    </li>
     <li class="toctree-l3"><a class="reference internal" href="#ispect-memory">Ispect memory</a>
     </li>
         </ul>
@@ -272,12 +274,15 @@ <h3 id="nested-structsunions">Nested structs/unions</h3>
     &quot;&quot;&quot;
 </code></pre>
 <h3 id="byte-order-size-and-padding">Byte Order, Size, and Padding</h3>
-<p>Suported byte orders:</p>
+<p>Python-CStruct supports big-endian, little-endian, and native byte orders, which you can specify using:</p>
 <ul>
-<li><code>cstruct.LITTLE_ENDIAN</code> - Little endian byte order, standard size, no padding</li>
-<li><code>cstruct.BIG_ENDIAN</code> - Big endian byte order, standard size, no padding</li>
-<li><code>cstruct.NATIVE_ORDER</code> - Native byte order, native size, padding</li>
+<li><code>cstruct.LITTLE_ENDIAN</code> - Little endian byte order, standard size, no padding.</li>
+<li><code>cstruct.BIG_ENDIAN</code> - Big endian byte order, standard size, no padding.</li>
+<li><code>cstruct.NATIVE_ORDER</code> - Native byte order, native size, padding. Native byte order is big-endian or little-endian, depending on the host system.</li>
 </ul>
+<p>Standard size depends only on the format character while native size depends on the host system.
+For native order, padding is automatically added to align the structure members.</p>
+<p>For more information, see the <a href="https://docs.python.org/3/library/struct.html#byte-order-size-and-alignment">struct - Byte Order, Size, and Padding</a> section.</p>
 <pre><code class="language-python">class Native(cstruct.MemCStruct):
     __byte_order__ = cstruct.NATIVE_ORDER
     __def__ = &quot;&quot;&quot;
@@ -400,6 +405,52 @@ <h3 id="define-sizeof-and-eval">Define, Sizeof, and Eval</h3>
         }
     &quot;&quot;&quot;
 </code></pre>
+<h3 id="accessing-field-definitions">Accessing Field Definitions</h3>
+<p>Python-CStruct provides the <code>__fields_types__</code> attribute at the class level, which allows you to inspect the metadata of each field.
+The dictionary contains each field's name as a key and its metadata as a value.
+Each field has the following attributes:</p>
+<table>
+<thead>
+<tr>
+<th>Attribute</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>kind</code></td>
+<td>Indicates whether the field is a primitive type or a nested struct.</td>
+</tr>
+<tr>
+<td><code>c_type</code></td>
+<td>The corresponding C type.</td>
+</tr>
+<tr>
+<td><code>ref</code></td>
+<td>If the field is a nested struct, this contains a reference to the class representing that struct.</td>
+</tr>
+<tr>
+<td><code>vlen_ex</code></td>
+<td>The number of elements in the field.</td>
+</tr>
+<tr>
+<td><code>flexible_array</code></td>
+<td>Indicates whether the field is a flexible array.</td>
+</tr>
+<tr>
+<td><code>byte_order</code></td>
+<td>The byte order of the field.</td>
+</tr>
+<tr>
+<td><code>offset</code></td>
+<td>The relative position of the field within the struct.</td>
+</tr>
+<tr>
+<td><code>padding</code></td>
+<td>The number of bytes added before this field for alignment.</td>
+</tr>
+</tbody>
+</table>
 <h3 id="ispect-memory">Ispect memory</h3>
 <p>The <a href="https://python-cstruct.readthedocs.io/en/latest/api/abstract/#cstruct.abstract.AbstractCStruct.inspect"><code>inspect</code></a> methods displays memory contents in hexadecimal.</p>
 <pre><code class="language-python">print(mbr.inspect())
@@ -490,5 +541,5 @@ <h2 id="links">Links</h2>
 
 <!--
 MkDocs version : 1.6.1
-Build Date UTC : 2025-01-16 19:35:50.915244+00:00
+Build Date UTC : 2025-02-18 05:53:39.039107+00:00
 -->