Exiffer.Binary (exiffer v0.6.4)

Copy Markdown

Documentation for Exiffer.Binary.

Summary

Types

rational()
signed_rational()

Functions

big_endian(binary)

Force big endian byte order

big_endian_to_current(binary)

Convert big endian to the currently selected byte order

big_endian_to_integer(arg)

Convert big-endian binary bytes to an integer.

big_endian_to_signed(arg)
byte_order()
int16u_to_big_endian(integer)

Convert a 16-bit integer to big-endian binary bytes.

int16u_to_current(integer)

Convert a 16-bit integer to binary bytes in current byte order.

int16u_to_little_endian(integer)

Convert a 16-bit integer to little-endian binary bytes.

int32s_to_big_endian(integer)
int32s_to_current(integer)
int32s_to_little_endian(integer)
int32u_to_big_endian(integer)

Convert a 32-bit integer to big-endian binary bytes.

int32u_to_current(integer)

Convert a 32-bit integer to binary bytes in current byte order.

int32u_to_little_endian(integer)

Convert a 32-bit integer to little-endian binary bytes.

little_endian_to_integer(arg)

Convert little-endian binary bytes to integer.

little_endian_to_signed(arg)
optionally_create_ets_table()
rational_to_current(rationals)
reverse(binary)

Reverse the given binary bytes

set_byte_order(byte_order)
signed_rational_to_current(rationals)
to_integer(binary)

Convert binary bytes to decimal based on endianness.

to_rational(arg)

When given 8 bytes, returns a single {numerator, denominator} tuple. When given multiples of 8 bytes, returns a list of those tuples.

to_signed(arg)
to_signed_rational(arg)

When given 8 bytes, returns a single {numerator, denominator} tuple. When given multiples of 8 bytes, returns a list of those tuples.

Types

rational()

@type rational() :: {non_neg_integer(), non_neg_integer()}

signed_rational()

@type signed_rational() :: {integer(), integer()}

Functions

big_endian(binary)

@spec big_endian(binary()) :: binary()

Force big endian byte order

big_endian_to_current(binary)

@spec big_endian_to_current(binary()) :: binary()

Convert big endian to the currently selected byte order

big_endian_to_integer(arg)

@spec big_endian_to_integer(binary()) :: non_neg_integer()

Convert big-endian binary bytes to an integer.

big_endian_to_signed(arg)

@spec big_endian_to_signed(<<_::32>>) :: integer()

byte_order()

@spec byte_order() :: :big | :little

int16u_to_big_endian(integer)

@spec int16u_to_big_endian(integer()) :: <<_::16>>

Convert a 16-bit integer to big-endian binary bytes.

int16u_to_current(integer)

@spec int16u_to_current(integer()) :: <<_::16>>

Convert a 16-bit integer to binary bytes in current byte order.

int16u_to_little_endian(integer)

@spec int16u_to_little_endian(integer()) :: <<_::16>>

Convert a 16-bit integer to little-endian binary bytes.

int32s_to_big_endian(integer)

@spec int32s_to_big_endian(integer()) :: <<_::32>>

int32s_to_current(integer)

@spec int32s_to_current(integer()) :: <<_::32>>

int32s_to_little_endian(integer)

@spec int32s_to_little_endian(integer()) :: <<_::32>>

int32u_to_big_endian(integer)

@spec int32u_to_big_endian(integer()) :: <<_::32>>

Convert a 32-bit integer to big-endian binary bytes.

int32u_to_current(integer)

@spec int32u_to_current(integer()) :: <<_::32>>

Convert a 32-bit integer to binary bytes in current byte order.

int32u_to_little_endian(integer)

@spec int32u_to_little_endian(integer()) :: <<_::32>>

Convert a 32-bit integer to little-endian binary bytes.

little_endian_to_integer(arg)

@spec little_endian_to_integer(binary()) :: non_neg_integer()

Convert little-endian binary bytes to integer.

little_endian_to_signed(arg)

@spec little_endian_to_signed(<<_::32>>) :: integer()

optionally_create_ets_table()

@spec optionally_create_ets_table() :: :ok

rational_to_current(rationals)

@spec rational_to_current(rational() | [rational()]) :: binary() | [binary()]
@spec rational_to_current(signed_rational() | [signed_rational()]) ::
  binary() | [binary()]

reverse(binary)

@spec reverse(binary()) :: binary()

Reverse the given binary bytes

set_byte_order(byte_order)

@spec set_byte_order(:big | :little) :: true

signed_rational_to_current(rationals)

to_integer(binary)

@spec to_integer(binary()) :: non_neg_integer()

Convert binary bytes to decimal based on endianness.

to_rational(arg)

@spec to_rational(binary()) :: rational() | [rational()]

When given 8 bytes, returns a single {numerator, denominator} tuple. When given multiples of 8 bytes, returns a list of those tuples.

to_signed(arg)

@spec to_signed(<<_::32>>) :: integer()

to_signed_rational(arg)

@spec to_signed_rational(binary()) :: signed_rational() | [signed_rational()]

When given 8 bytes, returns a single {numerator, denominator} tuple. When given multiples of 8 bytes, returns a list of those tuples.