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, num Number) []byte
  • func (b Bytes) GoString() string
• type Field
• type I32
  • func (i I32) Append(data []byte, num Number) []byte
  • func (i I32) GoString() string
• type I64
  • func (i I64) Append(data []byte, num Number) []byte
  • func (i I64) GoString() string
• type LenPrefix
  • func (p *LenPrefix) Append(data []byte, num Number) []byte
  • func (p *LenPrefix) GoString() string
• type Message
  • func (m *Message) Add(num Number, v func(*Message))
  • func (m *Message) AddBytes(num Number, v Bytes)
  • func (m *Message) AddI32(num Number, v I32)
  • func (m *Message) AddI64(num Number, v I64)
  • func (m *Message) AddVarint(num Number, v Varint)
  • func (m Message) Append(data []byte, num Number) []byte
  • func (m Message) Get(num Number) func() (Message, bool)
  • func (m Message) GetBytes(num Number) func() (Bytes, bool)
  • func (m Message) GetI32(num Number) func() (I32, bool)
  • func (m Message) GetI64(num Number) func() (I64, bool)
  • func (m Message) GetVarint(num Number) func() (Varint, bool)
  • func (m Message) GoString() string
  • func (m Message) Marshal() []byte
  • func (m *Message) Unmarshal(data []byte) error
• type Number
• type Value
• type Varint
  • func (v Varint) Append(data []byte, num Number) []byte
  • func (v Varint) GoString() string

Types

type Bytes

type Bytes []byte

protobuf.dev/programming-guides/encoding#cheat-sheet

func (Bytes) Append

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

func (Bytes) GoString

func (b Bytes) GoString() string

type Field

type Field struct {
	Number Number
	Value  Value
}

protobuf.dev/programming-guides/encoding#cheat-sheet-key

type I32

type I32 uint32

protobuf.dev/programming-guides/encoding#cheat-sheet

func (I32) Append

func (i I32) Append(data []byte, num Number) []byte

func (I32) GoString

func (i I32) GoString() string

type I64

type I64 uint64

protobuf.dev/programming-guides/encoding#cheat-sheet

func (I64) Append

func (i I64) Append(data []byte, num Number) []byte

func (I64) GoString

func (i I64) GoString() string

type LenPrefix

type LenPrefix struct {
	Bytes   Bytes
	Message Message
}

protobuf.dev/programming-guides/encoding#cheat-sheet

func (*LenPrefix) Append

func (p *LenPrefix) Append(data []byte, num Number) []byte

func (*LenPrefix) GoString

func (p *LenPrefix) GoString() string

type Message

type Message []Field

protobuf.dev/programming-guides/encoding#cheat-sheet

func (*Message) Add

func (m *Message) Add(num Number, v func(*Message))

wikipedia.org/wiki/Continuation-passing_style

func (*Message) AddBytes

func (m *Message) AddBytes(num Number, v Bytes)

func (*Message) AddI32

func (m *Message) AddI32(num Number, v I32)

func (*Message) AddI64

func (m *Message) AddI64(num Number, v I64)

func (*Message) AddVarint

func (m *Message) AddVarint(num Number, v Varint)

func (Message) Append

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

func (Message) Get

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

func (Message) GetBytes

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

func (Message) GetI32

func (m Message) GetI32(num Number) func() (I32, bool)

func (Message) GetI64

func (m Message) GetI64(num Number) func() (I64, bool)

func (Message) GetVarint

func (m Message) GetVarint(num 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

protobuf.dev/programming-guides/encoding#cheat-sheet-key

type Value

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

protobuf.dev/programming-guides/encoding#cheat-sheet

type Varint

type Varint uint64

protobuf.dev/programming-guides/encoding#cheat-sheet

func (Varint) Append

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

func (Varint) GoString

func (v Varint) GoString() string