bin_struct
▼
Project version
v0.2.16
v0.2.15
v0.2.14
v0.2.13
v0.2.12
v0.2.11
v0.2.10
v0.2.9
v0.2.8
v0.2.7
Pages
Modules
API Reference
Modules
Overview
BinStruct
What BinStruct is not
What BinStruct is primarily
Performance
Performance improvements for hot path
Future performance improvements
Installation
Syntax overview
Getting Started
View generated code
Configuration
Additional Documentation
Changelog
0.2.9
0.2.10
0.2.11
0.2.12
0.2.13
0.2.14
0.2.15
0.2.16
Types
asn1
binary
Terminated
Known length
Dynamic length
Unknown length
bool
1 byte
Variable bit size
enum
Integer based
Binaries based
flags
Defining struct with flags using integer mask
Variable bit size
float32_be
float32_le
float64_be
float64_le
int16_be
int16_le
int32_be
int32_le
int64_be
int64_le
int8
int_be
Variable bit size
int_le
Variable bit size
list_of
With compile time known bounds
With runtime known bounds
With only one criteria known
Without any bounds criteria
With manual selection upon dynamic criteria
Future exploring
Static value
Inline bytes
Optional
Inline bitstring
Inline String.t
Evaluated
uint16_be
uint16_le
uint32_be
uint32_le
uint64_be
uint64_le
uint8
uint_be
Variable bit size
uint_le
Variable bit size
variant_of
Static dispatch static value
Static enum
Dynamic dispatch
BinStruct
Sections
Overview
Summary
Functions
compile_decode_only/2
field/3
impl_interface/2
register_callback/2
register_option/2
virtual/3
BinStruct.BuiltIn.Recursive
Sections
Overview
Example Usage
Summary
Functions
dump_binary/2
from_managed_to_unmanaged/2
from_unmanaged_to_managed/2
init_args/1
known_total_size_bytes/1
module_code/0
parse_exact_returning_options/3
parse_returning_options/3
size/2
BinStruct.Macro.TopologyAdditionalSortAccordingToPriority
Summary
Functions
sort_topology_based_on_node_priority/3
Complex Types
BinStruct.BuiltIn.Asn1
Summary
Functions
dump_binary/2
from_managed_to_unmanaged/2
from_unmanaged_to_managed/2
init_args/1
known_total_size_bytes/1
module_code/0
parse_exact_returning_options/3
parse_returning_options/3
size/2
BinStruct.BuiltIn.TerminatedBinary
Summary
Functions
dump_binary/2
from_managed_to_unmanaged/2
from_unmanaged_to_managed/2
init_args/1
known_total_size_bytes/1
module_code/0
parse_exact_returning_options/3
parse_returning_options/3
size/2
Callback helpers
BinStruct.EnumValueByVariantName
Summary
Functions
find_enum_value_by_variant_name/2
BinStruct.EnumVariantNameByValue
Summary
Functions
find_enum_variant_name_by_value/2
BinStruct.FlagsReader
Summary
Functions
read_flags_from_integer/2
BinStruct.FlagsWriter
Summary
Functions
write_flags_to_integer/2
BinStruct.PrimitiveEncoder
Summary
Functions
bool/2
float32_be/1
float32_le/1
float64_be/1
float64_le/1
int8/1
int16_be/1
int16_le/1
int32_be/1
int32_le/1
int64_be/1
int64_le/1
int_be/2
int_le/2
uint8/1
uint16_be/1
uint16_le/1
uint32_be/1
uint32_le/1
uint64_be/1
uint64_le/1
uint_be/2
uint_le/2
Custom types interface
BinStructCustomType
Sections
Basic Example
Summary
Functions
register_option/2
Options interface
BinStructOptionsInterface
Summary
Functions
register_option/2
Search documentation of bin_struct
Settings
BinStruct.Macro.TopologyAdditionalSortAccordingToPriority
(bin_struct v0.2.16)
Summary
Functions
sort_topology_based_on_node_priority(topology, edges, priority_fun)
Functions
sort_topology_based_on_node_priority(topology, edges, priority_fun)
×