tonic v0.2.2 Tonic.Types
Link to this section Summary
Functions
Read a single bit boolean value
Read a 32-bit floating point
Read a 64-bit floating point
Read a 16-bit signed integer
Read a 32-bit signed integer
Read a 64-bit signed integer
Read an 8-bit signed integer
Read a string
Read a 16-bit unsigned integer
Read a 32-bit unsigned integer
Read a 64-bit unsigned integer
Read an 8-bit unsigned integer
Link to this section Functions
bit() (macro)
Read a single bit boolean value.
bit(label) (macro)
bit(label, endianness_or_fun) (macro)
bit(label, endianness, fun) (macro)
bit(currently_loaded, data, name, endianness)
float32() (macro)
Read a 32-bit floating point.
float32(label) (macro)
float32(label, endianness_or_fun) (macro)
float32(label, endianness, fun) (macro)
float32(currently_loaded, data, name, atom)
float64() (macro)
Read a 64-bit floating point.
float64(label) (macro)
float64(label, endianness_or_fun) (macro)
float64(label, endianness, fun) (macro)
float64(currently_loaded, data, name, atom)
int16() (macro)
Read a 16-bit signed integer.
int16(label) (macro)
int16(label, endianness_or_fun) (macro)
int16(label, endianness, fun) (macro)
int16(currently_loaded, data, name, atom)
int32() (macro)
Read a 32-bit signed integer.
int32(label) (macro)
int32(label, endianness_or_fun) (macro)
int32(label, endianness, fun) (macro)
int32(currently_loaded, data, name, atom)
int64() (macro)
Read a 64-bit signed integer.
int64(label) (macro)
int64(label, endianness_or_fun) (macro)
int64(label, endianness, fun) (macro)
int64(currently_loaded, data, name, atom)
int8() (macro)
Read an 8-bit signed integer.
int8(label) (macro)
int8(label, endianness_or_fun) (macro)
int8(label, endianness, fun) (macro)
int8(currently_loaded, data, name, atom)
string(name \\ [], options \\ []) (macro)
Read a string.
Default will read until end of data. Otherwise a length value can be specified length: 10
,
or it can read up to a terminator ?\n
or terminator: ?\n
, or both limits can be applied.
The string can have its trailing characters stripped by using strip: ?\n
or strip: "\n"
.
Examples
string :read_to_end
string :read_8_chars, length: 8
string :read_till_nul, 0
string :read_till_newline, ?\n
string :read_till_newline_or_8_chars, length: 8, terminator: ?\n
string :read_to_end_remove_newline, strip: ?\n
uint16() (macro)
Read a 16-bit unsigned integer.
uint16(label) (macro)
uint16(label, endianness_or_fun) (macro)
uint16(label, endianness, fun) (macro)
uint16(currently_loaded, data, name, atom)
uint32() (macro)
Read a 32-bit unsigned integer.
uint32(label) (macro)
uint32(label, endianness_or_fun) (macro)
uint32(label, endianness, fun) (macro)
uint32(currently_loaded, data, name, atom)
uint64() (macro)
Read a 64-bit unsigned integer.
uint64(label) (macro)
uint64(label, endianness_or_fun) (macro)
uint64(label, endianness, fun) (macro)
uint64(currently_loaded, data, name, atom)
uint8() (macro)
Read an 8-bit unsigned integer.