View Source Slipstream.Serializer behaviour (Slipstream v1.2.0)

A behaviour that serializes incoming and outgoing socket messages.

Summary

Callbacks

decode!(binary, options)

Decodes binary into Slipstream.Message struct.

encode!(t, options)

Encodes Slipstream.Message structs to binary.

Callbacks

Link to this callback

decode!(binary, options)

View Source 
@callback decode!(binary(), options :: Keyword.t()) :: Slipstream.Message.t()

Decodes binary into Slipstream.Message struct.

Link to this callback

encode!(t, options)

View Source 
@callback encode!(Slipstream.Message.t(), options :: Keyword.t()) ::
  binary() | {:binary, binary()}

Encodes Slipstream.Message structs to binary.

Should return either a binary (string) when using a text based protocol or {:binary, binary} for cases where a binary protocol is used over the wire (such as MessagePack).