usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

lib.data: improve FlexibleLayout documentation.

Browse source 
Co-authored-by: mcclure <mcclure@users.noreply.github.com>
This commit is contained in:
Catherine 2023-12-01 20:36:10 +00:00
parent ef5cfa72bc
commit 3597c48eee
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
amaranth/lib/data.py
View file

@ -483,7 +483,12 @@ class ArrayLayout(Layout):
class FlexibleLayout(Layout):
"""Description of a flexible layout.
The fields of a flexible layout can be located arbitrarily, and its size is explicitly defined.
A flexible layout is similar to a structure layout; while fields in :class:`StructLayout` are
defined contiguously, the fields in a flexible layout can overlap and have gaps between them.
Because the size and field boundaries in a flexible layout can be defined arbitrarily, it
may also be more convenient to use a flexible layout when the layout information is derived
from an external data file rather than defined in Python code.
For example, the following layout of a 16-bit value:
@ -501,7 +506,10 @@ class FlexibleLayout(Layout):
})
Both strings and integers can be used as names of flexible layout fields, so flexible layouts
can be used to describe structures and arrays with arbitrary padding.
can be used to describe structures with arbitrary padding and arrays with arbitrary stride.
If another data structure is used as the source of truth for creating flexible layouts,
consider instead inheriting from the base :class:`Layout` class, which may be more convenient.
Attributes
----------