EdgeDB
v0.6.1

View Source EdgeDB.Protocol.Codec protocol (EdgeDB v0.6.1)

A codec knows how to work with the internal binary data from EdgeDB. The binary protocol specification for the codecs can be found on the official EdgeDB site. Useful links for codec developers:

Link to this section Summary

Types

id()

Codec ID.

t()

All the types that implement this protocol.

Functions

decode(codec, data, codec_storage)

Function that can decode EdgeDB binary format into an entity.

encode(codec, value, codec_storage)

Function that can encode an entity to EdgeDB binary format.

Link to this section Types

Link to this type

id()

View Source (since 0.2.0) 
@type id() :: bitstring()

Codec ID.

Link to this type

t()

View Source (since 0.2.0) 
@type t() :: term()

All the types that implement this protocol.

Link to this section Functions

Link to this function

decode(codec, data, codec_storage)

View Source (since 0.2.0) 
@spec decode(t(), bitstring(), EdgeDB.Protocol.CodecStorage.t()) :: value
when value: term()

Function that can decode EdgeDB binary format into an entity.

Link to this function

encode(codec, value, codec_storage)

View Source (since 0.2.0) 
@spec encode(t(), value, EdgeDB.Protocol.CodecStorage.t()) :: iodata()
when value: term()

Function that can encode an entity to EdgeDB binary format.