binmap¶
-
class
binmap.
BaseDescriptor
(name='')¶ Bases:
object
Base class for all descriptors
Parameters: name – Variable name
-
class
binmap.
BinField
(name='')¶ Bases:
binmap.BaseDescriptor
BinField descriptor tries to pack it into a struct before setting the value as a bounds checker
-
class
binmap.
BinmapDataclass
(_binarydata: dataclasses.InitVar = b'')¶ Bases:
object
Dataclass that does the converting to and from binary data
-
frombytes
(value: bytes)¶ Unpacks value to each field :param bytes value: binary string to unpack
-
-
class
binmap.
ConstField
(name='')¶ Bases:
binmap.BinField
ConstField descriptor keeps it’s value
-
class
binmap.
EnumField
(name='')¶ Bases:
binmap.BinField
EnumField descriptor uses “enum” to map to and from strings. Accepts both strings and values when setting. Only values that has a corresponding string is allowed.
-
class
binmap.
PaddingField
(name='')¶ Bases:
binmap.BaseDescriptor
PaddingField descriptor is used to “pad” data with values unused for real data
-
binmap.
constant
(value: Union[int, float, str]) → dataclasses.Field¶ Field generator function for constant elements
Parameters: value – Constant value for the field. Returns: dataclass field
-
binmap.
enumfield
(enumclass: enum.IntEnum, default: enum.IntEnum = None) → dataclasses.Field¶ Field generator function for enum field
Parameters: - enumclass (IntEnum) – Class with enums.
- default (IntEnum) – default value
Returns: dataclass field
-
binmap.
padding
(length: int = 1) → dataclasses.Field¶ Field generator function for padding elements
Parameters: lenght (int) – Number of bytes of padded field Returns: dataclass field
-
binmap.
stringfield
(length: int = 1, default: bytes = b'', fillchar: bytes = b' ') → dataclasses.Field¶ Field generator function for string fields.
Parameters: - lenght (int) – lengt of the string.
- default (bytes) – default value of the string
- fillchar (bytes) – char to pad the string with
Returns: dataclass field