protolua

Documentation

Index

• Constants
• func Marshal(m proto.Message) ([]byte, error)
• type Encoder
  • func NewEncoder(indent string) (*Encoder, error)
  • func (e *Encoder) Bytes() []byte
  • func (e *Encoder) EndArray()
  • func (e *Encoder) EndObject()
  • func (e *Encoder) EndString()
  • func (e *Encoder) StartArray()
  • func (e *Encoder) StartObject()
  • func (e *Encoder) StartString()
  • func (e *Encoder) WriteBool(b bool)
  • func (e *Encoder) WriteIndexedList(i int)
  • func (e *Encoder) WriteInt(n int64)
  • func (e *Encoder) WriteKey(s string) error
  • func (e *Encoder) WriteNull()
  • func (e *Encoder) WriteNumber(number string)
  • func (e *Encoder) WriteString(s string) error
  • func (e *Encoder) WriteUint(n uint64)
• type EncodingRun
• type JsonName
• type LuaMarshalOption
  • func (o LuaMarshalOption) Marshal(m proto.Message) ([]byte, error)
• type MarshalFunc
• type ProtobufName

Constants

const ArrayClose = "}"

const ArrayOpen = "{"

const BeginString = "\""

const BoolFalse = "false"

const BoolTrue = "true"

const DefaultIndent = "  "

const EndString = "\""

const GoogleProtobufParentPackage = "google.protobuf"

const GoogleProtobufTimestamp = "Timestamp"

const KeyAssign = "="

const NullValue = "nil"

const TableClose = "}"

const TableOpen = "{"

Functions

func Marshal

func Marshal(m proto.Message) ([]byte, error)

Marshal converts the given proto.Message into a lua table using default options. Supports only proto3 messages currently.

Types

type Encoder

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

func NewEncoder

func NewEncoder(indent string) (*Encoder, error)

func (*Encoder) Bytes

func (e *Encoder) Bytes() []byte

func (*Encoder) EndArray

func (e *Encoder) EndArray()

func (*Encoder) EndObject

func (e *Encoder) EndObject()

func (*Encoder) EndString

func (e *Encoder) EndString()

func (*Encoder) StartArray

func (e *Encoder) StartArray()

func (*Encoder) StartObject

func (e *Encoder) StartObject()

func (*Encoder) StartString

func (e *Encoder) StartString()

func (*Encoder) WriteBool

func (e *Encoder) WriteBool(b bool)

WriteBool writes out the given boolean value.

func (*Encoder) WriteIndexedList

func (e *Encoder) WriteIndexedList(i int)

func (*Encoder) WriteInt

func (e *Encoder) WriteInt(n int64)

func (*Encoder) WriteKey

func (e *Encoder) WriteKey(s string) error

func (*Encoder) WriteNull

func (e *Encoder) WriteNull()

WriteNull writes out the null value.

func (*Encoder) WriteNumber

func (e *Encoder) WriteNumber(number string)

func (*Encoder) WriteString

func (e *Encoder) WriteString(s string) error

WriteString escaped the string according to rules needed for luatex

func (*Encoder) WriteUint

func (e *Encoder) WriteUint(n uint64)

type EncodingRun

type EncodingRun struct {
	*Encoder
	// contains filtered or unexported fields
}

type JsonName

type JsonName struct {
}

default for KeyName, will use the jsonName for keys. Except for the root messages where the json name can not be extracted.

type LuaMarshalOption

type LuaMarshalOption struct {
	Format struct {
		// If set to false the lua table with be outputed in one line (default)
		// If set to true the lua table with be outputed in multiple line (better for humans)
		Multiline bool
	}

	// If set to nil, jsonName will be used
	KeyName interface {
		// contains filtered or unexported methods
	}

	// Marshalers for none standard proto messages
	AdditionalMarshalers []interface {
		Handle(fullName protoreflect.FullName) (MarshalFunc, error)
	}
}

func (LuaMarshalOption) Marshal

func (o LuaMarshalOption) Marshal(m proto.Message) ([]byte, error)

Marshal convert the given proto.Message into a lua table using the given options.

type MarshalFunc

type MarshalFunc func(EncodingRun, protoreflect.Message) error

type ProtobufName

type ProtobufName struct {
}

will use protobufName for keys