codec

Documentation

Index

• Constants
• func Register()
• type Frame
  • func (f *Frame) ProtoMessage()
  • func (f Frame) Raw() []byte
• type Proxy
  • func (p *Proxy) Marshal(v any) ([]byte, error)
  • func (*Proxy) Name() string
  • func (p *Proxy) Unmarshal(data []byte, v any) error

Constants

const Name = "proto"

Name is the name by which the proxy codec is registered in the encoding codec registry We have to say that we are the "proto" codec otherwise marshaling will fail.

Functions

func Register

func Register()

Register manually registers the codec.

Types

type Frame

type Frame struct {
	// contains filtered or unexported fields
}

Frame holds the proxy transported data.

func (*Frame) ProtoMessage

func (f *Frame) ProtoMessage()

ProtoMessage tags a frame as valid proto message.

func (Frame) Raw

func (f Frame) Raw() []byte

Raw returns the raw message. This is primarily useful for debugging.

type Proxy

type Proxy struct {
	// contains filtered or unexported fields
}

Proxy satisfies the encoding.Codec interface.

func (*Proxy) Marshal

func (p *Proxy) Marshal(v any) ([]byte, error)

Marshal implements the encoding.Codec interface method.

func (*Proxy) Name

func (*Proxy) Name() string

Name implements the encoding.Codec interface method.

func (*Proxy) Unmarshal

func (p *Proxy) Unmarshal(data []byte, v any) error

Unmarshal implements the encoding.Codec interface method.