Exmbus.Parser.Apl.FormatFrame (Exmbus v0.6.1)

Parser for a format frame.

A FormatFrame contains headers. It can be used on combination with a CompactFrame to create a full frame.

Summary

t()

Parse a FormatFrame from header bytes (no length or format signature)

parse(ctx)

Convert the format frame to bytes.

@type t() :: %Exmbus.Parser.Apl.FormatFrame{
  headers: [Exmbus.Parser.Apl.DataRecord.Header.t()]
}

@spec from_header_bytes(binary()) :: {:ok, t()} | {:error, [any()]}

Parse a FormatFrame from header bytes (no length or format signature)

This is usually required to get a FormatFrame from stored header bytes.

@spec to_header_bytes(t()) :: binary()

Convert the format frame to bytes.

This is useful for persisting the format frames or for calculating the format signature.