dissect.cstruct 4.8.dev3__py3-none-any.whl → 4.8.dev4__py3-none-any.whl

{dissect_cstruct-4.8.dev3.dist-info → dissect_cstruct-4.8.dev4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.cstruct
-Version: 4.8.dev3
+Version: 4.8.dev4
 Summary: A Dissect module implementing a parser for C-like structures: structure parsing in Python made easy
 Author-email: Dissect Team <dissect@fox-it.com>
 License-Expression: Apache-2.0
@@ -238,6 +238,26 @@ The API to access enum and flag members and their values in the same way as the
 ### Custom types
 You can implement your own types by subclassing `BaseType`, and adding them to your cstruct instance with `add_custom_type(name, type, size, alignment, ...)`
 
+### Dynamic length fields
+To read all remaining data in the provided buffer/stream, you can use the magic `EOF` size variable. This will automatically expand until the end of the stream has been reached and works for any field type. For example:
+
+```python
+from dissect.cstruct import cstruct
+
+eof_def = """
+struct example {
+    uint32 magic;
+    char data[EOF];
+};
+"""
+
+c_eof = cstruct().load(eof_def)
+
+example = c_eof.example(b"9\x05\x00\x00arbitrary length data")
+assert example.magic == 1337
+assert example.data == b"arbitrary length data"
+```
+
 ### Custom definition parsers
 Don't like the C-like definition syntax? Write your own syntax parser!
 

{dissect_cstruct-4.8.dev3.dist-info → dissect_cstruct-4.8.dev4.dist-info}/RECORD

@@ -20,10 +20,10 @@ dissect/cstruct/types/pointer.py,sha256=PqeJOoNBUfMd5uO2kpF6OHeW7Q6R1N1W1V4q1Mak
 dissect/cstruct/types/structure.py,sha256=FQv6x-vXm6h27FaqRBW7JKYVwtKMCg4jI4ZDIbYKEwo,33029
 dissect/cstruct/types/void.py,sha256=Gvh0HqI6jQSj2uesdo3J8-G41brWCz8pmP16l8xTBxE,1074
 dissect/cstruct/types/wchar.py,sha256=N9Y_XX2_hZEe2DwepJjxsB6xuRJ6zINRalcUofR59kY,2608
-dissect_cstruct-4.8.dev3.dist-info/licenses/COPYRIGHT,sha256=H-18RXfshdH9AdHwW2eO1Xa-5s6tY5eipHh5c0whDu4,316
-dissect_cstruct-4.8.dev3.dist-info/licenses/LICENSE,sha256=PhUqiw6jAh2KbBdVRPBq_hfAvfcTBin7nZ3CK7NQbTM,11341
-dissect_cstruct-4.8.dev3.dist-info/METADATA,sha256=onUUwnmI3Xgi5GO7FXY6Ih6JvimOj4EUQQyBzqfX4mY,8706
-dissect_cstruct-4.8.dev3.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
-dissect_cstruct-4.8.dev3.dist-info/entry_points.txt,sha256=z53zqZqwD2OLrAkRwrP4wTeiU9CQe7xrMly0T2c0_wQ,71
-dissect_cstruct-4.8.dev3.dist-info/top_level.txt,sha256=Mn-CQzEYsAbkxrUI0TnplHuXnGVKzxpDw_po_sXpvv4,8
-dissect_cstruct-4.8.dev3.dist-info/RECORD,,
+dissect_cstruct-4.8.dev4.dist-info/licenses/COPYRIGHT,sha256=H-18RXfshdH9AdHwW2eO1Xa-5s6tY5eipHh5c0whDu4,316
+dissect_cstruct-4.8.dev4.dist-info/licenses/LICENSE,sha256=PhUqiw6jAh2KbBdVRPBq_hfAvfcTBin7nZ3CK7NQbTM,11341
+dissect_cstruct-4.8.dev4.dist-info/METADATA,sha256=FzjujlDF19JNZjyuisVFAdif7IVKu0HJfJ3aUyNeP0I,9255
+dissect_cstruct-4.8.dev4.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+dissect_cstruct-4.8.dev4.dist-info/entry_points.txt,sha256=z53zqZqwD2OLrAkRwrP4wTeiU9CQe7xrMly0T2c0_wQ,71
+dissect_cstruct-4.8.dev4.dist-info/top_level.txt,sha256=Mn-CQzEYsAbkxrUI0TnplHuXnGVKzxpDw_po_sXpvv4,8
+dissect_cstruct-4.8.dev4.dist-info/RECORD,,

{dissect_cstruct-4.8.dev3.dist-info → dissect_cstruct-4.8.dev4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.0)
+Generator: setuptools (82.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any