protobuf

README

ProtoBuf

In the name of the warrior, I charge you to be brave.
In the name of the father, I charge you to be just.
In the name of the mother, I charge you to defend the innocent.

A Knight of the Seven Kingdoms (Game of Thrones) (2019)

Protocol Buffers

This module parses and formats the raw wire encoding.

• https://protobuf.dev/programming-guides/encoding#order
• https://wikipedia.org/wiki/Protocol_Buffers

prior art

• https://github.com/VictoriaMetrics/easyproto/issues/5
• https://github.com/philpearl/plenc/issues/9
• https://github.com/richardartoul/molecule/issues/24
• https://github.com/segmentio/encoding/issues/135

Documentation

Index

• type Bytes
  • func (b Bytes) Append(data []byte, key Number) []byte
  • func (b Bytes) GoString() string
• type Fixed32
  • func (f Fixed32) Append(data []byte, key Number) []byte
  • func (f Fixed32) GoString() string
• type Fixed64
  • func (f Fixed64) Append(data []byte, key Number) []byte
  • func (f Fixed64) GoString() string
• type Message
  • func (m Message) Add(key Number, f func(Message))
  • func (m Message) AddBytes(key Number, v Bytes)
  • func (m Message) AddFixed32(key Number, v Fixed32)
  • func (m Message) AddFixed64(key Number, v Fixed64)
  • func (m Message) AddMessage(key Number, v Message)
  • func (m Message) AddVarint(key Number, v Varint)
  • func (m Message) Append(data []byte, key Number) []byte
  • func (m Message) Get(key Number) func() (Message, bool)
  • func (m Message) GetBytes(key Number) func() (Bytes, bool)
  • func (m Message) GetFixed32(key Number) func() (Fixed32, bool)
  • func (m Message) GetFixed64(key Number) func() (Fixed64, bool)
  • func (m Message) GetVarint(key Number) func() (Varint, bool)
  • func (m Message) GoString() string
  • func (m Message) Marshal() []byte
  • func (m Message) Unmarshal(data []byte) error
• type Number
• type Unknown
  • func (u Unknown) Append(data []byte, key Number) []byte
  • func (u Unknown) GoString() string
  • func (u Unknown) Marshal() []byte
• type Value
• type Varint
  • func (v Varint) Append(data []byte, key Number) []byte
  • func (v Varint) GoString() string

Types

type Bytes

type Bytes []byte

func (Bytes) Append

func (b Bytes) Append(data []byte, key Number) []byte

func (Bytes) GoString

func (b Bytes) GoString() string

type Fixed32

type Fixed32 uint32

func (Fixed32) Append

func (f Fixed32) Append(data []byte, key Number) []byte

func (Fixed32) GoString

func (f Fixed32) GoString() string

type Fixed64

type Fixed64 uint64

func (Fixed64) Append

func (f Fixed64) Append(data []byte, key Number) []byte

func (Fixed64) GoString

func (f Fixed64) GoString() string

type Message

type Message map[Number][]Value

func (Message) Add

func (m Message) Add(key Number, f func(Message))

func (Message) AddBytes

func (m Message) AddBytes(key Number, v Bytes)

func (Message) AddFixed32

func (m Message) AddFixed32(key Number, v Fixed32)

func (Message) AddFixed64

func (m Message) AddFixed64(key Number, v Fixed64)

func (Message) AddMessage

func (m Message) AddMessage(key Number, v Message)

func (Message) AddVarint

func (m Message) AddVarint(key Number, v Varint)

func (Message) Append

func (m Message) Append(data []byte, key Number) []byte

func (Message) Get

func (m Message) Get(key Number) func() (Message, bool)

func (Message) GetBytes

func (m Message) GetBytes(key Number) func() (Bytes, bool)

func (Message) GetFixed32

func (m Message) GetFixed32(key Number) func() (Fixed32, bool)

func (Message) GetFixed64

func (m Message) GetFixed64(key Number) func() (Fixed64, bool)

func (Message) GetVarint

func (m Message) GetVarint(key Number) func() (Varint, bool)

func (Message) GoString

func (m Message) GoString() string

func (Message) Marshal

func (m Message) Marshal() []byte

func (Message) Unmarshal

func (m Message) Unmarshal(data []byte) error

type Number

type Number = protowire.Number

type Unknown

type Unknown struct {
	Bytes   Bytes
	Message Message
}

func (Unknown) Append

func (u Unknown) Append(data []byte, key Number) []byte

func (Unknown) GoString

func (u Unknown) GoString() string

func (Unknown) Marshal

func (u Unknown) Marshal() []byte

type Value

type Value interface {
	Append([]byte, Number) []byte
	fmt.GoStringer
}

type Varint

type Varint uint64

func (Varint) Append

func (v Varint) Append(data []byte, key Number) []byte

func (Varint) GoString

func (v Varint) GoString() string