Codex (bin_codex v0.1.0)
Link to this section Summary
Link to this section Types
Link to this type
decode_result()
Specs
decode_result() :: {:ok, type(), remaining_bits()} | {:error, Sting.t(), remaining_bits()}
Link to this type
decoder()
Specs
decoder() :: (bitstring() -> decode_result())
Link to this type
encode_result()
Specs
encode_result() :: {:ok, bitstring()} | {:error, Sting.t()}
Link to this type
encoder()
Specs
encoder() :: (type() -> encode_result())
Link to this type
remaining_bits()
Specs
remaining_bits() :: bitstring()
Link to this type
type()
Specs
type() :: any()
Link to this section Functions
Link to this function
byte()
Specs
Link to this function
bytes(count)
Specs
bytes(non_neg_integer()) :: %Codex{decode: term(), encode: term()}
Link to this function
combine(codec1, codec2)
Specs
Link to this function
cons(codec, list_codec)
Specs
Link to this function
convert(codec, convert_to, convert_from)
Specs
Link to this function
create(encode, decode)
Specs
Link to this function
decode(bits, codex)
Specs
decode(bitstring(), %Codex{decode: term(), encode: term()}) :: decode_result()
Link to this function
empty()
Specs
Link to this function
encode(value, codex)
Specs
encode(type(), %Codex{decode: term(), encode: term()}) :: encode_result()
Link to this function
list_of(count, codec)
Specs
list_of(non_neg_integer(), %Codex{decode: term(), encode: term()}) :: %Codex{ decode: term(), encode: term() }
Link to this function