Current section

Files

Jump to
elixir_xdr lib xdr declaration.ex
Raw

lib/xdr/declaration.ex

defmodule XDR.Declaration do
@moduledoc """
Behaviour definition that is in charge of keeping the types declared by the RFC4506 standard with these specifications
"""
alias XDR.Error
# encode XDR for any type returns a tuple with the resulted binary value
@callback encode_xdr(struct) :: {:ok, binary} | Error.t()
# encode XDR for any type returns the resulted binary value
@callback encode_xdr!(struct) :: binary | Error.t()
# decode XDR for any type returns a tuple with the converted value
@callback decode_xdr(binary, term) :: {:ok, {term, binary}} | Error.t()
# decode XDR for any type returns the resulted converted value
@callback decode_xdr!(binary, term) :: {term, binary} | Error.t()
end