API Reference

HexIO API

HexIO.unpack — Function

unpack(io::IO, T::Type, endianness::Symbol = :NativeEndian)

Given an input io, unpack type T, byte-swapping according to the given endianness of io. If endianness is :NativeEndian (the default), no byteswapping will occur. If endianness is :LittleEndian or :BigEndian, byteswapping will occur of the endianness if the host system does not match the endianness of io.

source

HexIO.pack — Function

pack(io::IO, source, endianness::Symbol = :NativeEndian)

Given an input source, pack it into io, byte-swapping according to the given endianness of io. If endianness is :NativeEndian (the default), no byteswapping will occur. If endianness is :LittleEndian or :BigEndian, byteswapping will occur if the endianness of the host system does not match the endianness of io.

source

HexIO.fix_endian — Function

fix_endian(x, endianness::Symbol)

Returns a byte-swapped version of x if the given endianness must be swapped for the current host system.

source

Missing docstring.

Missing docstring for HexIO.packed_sizeof. Check Documenter's build log for details.

HexIO.@io — Macro

@io <type definition>
    ...
end

Generates packing_strategy() and packed_sizeof() methods for the type being defined within the given type definition. This enables usage of the unpack method.

source

HexIO.Hex — Type

Hex(filename::AbstractString, _offset::Int=0)

source

Hex(io::IO, _offset::Int=0)

source

HexIO.dump! — Function

dump!(s::Hex, start=nothing, n=nothing)

display data chunk of n size beginning at offset

source

HexIO.edit! — Function

edit!(s::Hex, datastr::AbstractString, start=nothing)

edit binary file.

source

HexIO.find! — Function

find!(s::Hex, sigstr::AbstractString, start=nothing)

search for binary signature and return the offset or nothing; modify s._offset to point to beginning of located signature

source