protobuf

Documentation

Index

• func GetParsedSchema(data []byte) (schema.ParsedSchema, error)
• type Schema
  • func (s *Schema) Format() string
  • func (s *Schema) GetCanonicalValue() *schema.SchemaFile
  • func (s *Schema) IsBackwardCompatible(against schema.ParsedSchema) error
  • func (s *Schema) IsForwardCompatible(against schema.ParsedSchema) error
  • func (s *Schema) IsFullCompatible(against schema.ParsedSchema) error

Functions

func GetParsedSchema

func GetParsedSchema(data []byte) (schema.ParsedSchema, error)

GetParsedSchema converts data into enriched data type to deal with protobuf schema

Types

type Schema

type Schema struct {
	*protoregistry.Files
	// contains filtered or unexported fields
}

func (*Schema) Format

func (s *Schema) Format() string

func (*Schema) GetCanonicalValue

func (s *Schema) GetCanonicalValue() *schema.SchemaFile

func (*Schema) IsBackwardCompatible

func (s *Schema) IsBackwardCompatible(against schema.ParsedSchema) error

IsBackwardCompatible checks backward compatibility against given schema Allowed changes: field addition Disallowed changes: field type change, tag number change, label change, field deletion

func (*Schema) IsForwardCompatible

func (s *Schema) IsForwardCompatible(against schema.ParsedSchema) error

IsForwardCompatible for protobuf forward compatible is same as backward compatible Allowed changes: field addition, field deletion given tag number marked as reserved Disallowed changes: field type change, tag number change, label change

func (*Schema) IsFullCompatible

func (s *Schema) IsFullCompatible(against schema.ParsedSchema) error

IsFullCompatible for protobuf forward compatible is same as backward compatible