tonic v0.0.1 Tonic.Types

Summary

Functions

bit(currently_loaded, data, name, endianness)
convert_to_string(values)
convert_to_string_without_last_byte(values)
float32(currently_loaded, data, name, atom)
float64(currently_loaded, data, name, atom)
int16(currently_loaded, data, name, atom)
int32(currently_loaded, data, name, atom)
int64(currently_loaded, data, name, atom)
int8(currently_loaded, data, name, atom)
uint16(currently_loaded, data, name, atom)
uint32(currently_loaded, data, name, atom)
uint64(currently_loaded, data, name, atom)
uint8(currently_loaded, data, name, atom)

Macros

bit()

Read a single bit boolean value.

bit(label)
bit(label, endianness_or_fun)
bit(label, endianness, fun)
float32()

Read a 32-bit floating point.

float32(label)
float32(label, endianness_or_fun)
float32(label, endianness, fun)
float64()

Read a 64-bit floating point.

float64(label)
float64(label, endianness_or_fun)
float64(label, endianness, fun)
int16()

Read a 16-bit signed integer.

int16(label)
int16(label, endianness_or_fun)
int16(label, endianness, fun)
int32()

Read a 32-bit signed integer.

int32(label)
int32(label, endianness_or_fun)
int32(label, endianness, fun)
int64()

Read a 64-bit signed integer.

int64(label)
int64(label, endianness_or_fun)
int64(label, endianness, fun)
int8()

Read an 8-bit signed integer.

int8(label)
int8(label, endianness_or_fun)
int8(label, endianness, fun)
string(name \\ [], options \\ [])

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.

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
uint16()

Read a 16-bit unsigned integer.

uint16(label)
uint16(label, endianness_or_fun)
uint16(label, endianness, fun)
uint32()

Read a 32-bit unsigned integer.

uint32(label)
uint32(label, endianness_or_fun)
uint32(label, endianness, fun)
uint64()

Read a 64-bit unsigned integer.

uint64(label)
uint64(label, endianness_or_fun)
uint64(label, endianness, fun)
uint8()

Read an 8-bit unsigned integer.

uint8(label)
uint8(label, endianness_or_fun)
uint8(label, endianness, fun)