Utils

@bin_str(x)::BitVector

Converts binary representation to BitVector:

bin"1010" == BitVector([1, 0, 1, 0])

@check(ex, msg = nothing)

Drop in replacement for @assert macro as it can be eliminated in optimizations.

@hex_str(x)::Vector{UInt8}

A convinience macro for converting a hex to byte vector:

hex"AAEF BBEC" == UInt8[0xaa, 0xef, 0xbb, 0xec]

bits2octet(x::BitVector)::Vector{UInt8}

Converts a bitvector to an octet.

dynamic(x)

Converts static type to it's closest base type. Inverse of static method.

int2octet(x::Integer, N::Int = bitlength(x))::Vector{UInt8}

Converts integer x into an octet where optional N specifies number of allocated bits for the integer encoding.

octet2bits(x::Vector{UInt8}[, N::Int])::BitVector

Converts an octet ot a bitvector with an optionally specified length N.

octet2int(x::Vector{UInt8})::BigInt
octet2int(x::String)::BigInt

Converts a binary octet to a BigInt. In case a string is passed it is treated as hexadecimal and is converted with hex2bytes. Equivalent in represeentation as parse(BigInt, bytes2hex(x), base=16).

static(x)
static(; kwargs...)

If x is not bitstype converts to a bitstype representation. Keyword arguments are used to construct a named tuple with every value being converted with static. Can be converted back to original type with dynamic method.

Example

# Single argument case
x = BigInt(23)
isbitstype(typeof(x)) == false
isbitstype(typeof(static(x))) == true
x == dynamic(static(x))

# NamedTuple construction

nt = static(; x = BigInt(23), y = 51, z = :name)
isbittstype(typeof(nt)) == true
nt.x == BigInt(23) # accessor methods do conversion with dynamic
dynamic(nt) # ordinary named tuple with every value made dynamic