Gel.Protocol.Codec protocol (Gel v0.9.0)
View SourceA codec knows how to work with the internal binary data from Gel.
The binary protocol specification for the codecs can be found in the relevant part of the Gel documentation.
Useful links for codec developers:
- Gel datatypes used in data descriptions.
- Gel data wire formats.
- Built-in Gel codec implementations.
- Custom codecs implementations.
- Guide to developing custom codecs on hex.pm.
Summary
Functions
Function that can decode Gel binary format into an entity.
Function that can encode an entity to Gel binary format.
Types
Functions
@spec decode(t(), bitstring(), Gel.Protocol.CodecStorage.t()) :: value when value: term()
Function that can decode Gel binary format into an entity.
@spec encode(t(), value, Gel.Protocol.CodecStorage.t()) :: iodata() when value: term()
Function that can encode an entity to Gel binary format.