12.1 ios_dump_bytes

The ios_dump_bytes function prints a byte dump of an area in a given IO space.

It has the following prototype:

fun ios_dump_bytes = (int<32> ios,
                      offset<uint<64>,b> from,
                      offset<uint<64>,b> size,
                      any val = -1,
                      offset<uint<64>, b> group_by = 2#B,
                      int<32> cluster_by = 8,
                      int<32> ruler = 0,
                      int<32> ascii = 0,
                      string unknown_byte = "??",
                      uint<8> nonprintable_char = '.') void

Where ios is the IO space form which dump bytes.

from is the offset from which start dumping bytes. This location is truncated to bytes.

size is an offset specifying the amount of bytes to dump. The offset is rounded up to the next byte.

val Instead of an explicit from+size range, a mapped value can be specified using the val argument. In this case, dump will show the bytes corresponding to the given value, with visual indications on what bytes correspond to what element contained in the value.

group_by determines how the bytes are grouped together in the output. Defaults to two bytes.

cluster_by specifies to display additioanl space after the specified number of groups have been displayed. Defaults to 8.

ruler is a boolean determining whether to include a ruler line in the output. Defaults to 0.

ascii_p is a boolean determining whether to include an ASCII dump. Defaults to 0.

unknown_byte is the string to use to denote bytes that can’t be read from the IO space. Defaults to "??". Note this string is expected to be of length two characters.

nonprintable_char is the character code to use to denote non-printable characters. Defaults to '.'.

This function may raise E_io, E_perm, and E_eof on several error conditions.