avro

Documentation

Overview

Package avro provides a user functionality to return the avro encoding of s.

Index

• Variables
• func ErrUnsupportedType(typ reflect.Kind) error
• type Footballer
• type FootballerName
• type NestedTestData
• type Schema
  • func (schema *Schema) Marshal(s interface{}) ([]byte, error)
  • func (schema *Schema) Unmarshal(message []byte, s interface{}) error

Variables

var ErrMissingNestedScema = errors.New("nested schema missing from parent")

ErrMissingNestedScema is returned when nested schemas are missing from the parent

var ErrUnsupportedFieldType = errors.New("Unsupported field type")

ErrUnsupportedFieldType is returned for unsupported field types.

Functions

func ErrUnsupportedType

func ErrUnsupportedType(typ reflect.Kind) error

ErrUnsupportedType is returned if the interface isn't a pointer to a struct

Types

type Footballer

type Footballer struct {
	Email string `avro:"email"`
	Name  string `avro:"name"`
}

Footballer represents the details of a footballer

type FootballerName

type FootballerName struct {
	Surname  string            `avro:"surname"`
	Forename string            `avro:"forename"`
	AKA      map[string]string `avro:"aka"`
}

FootballerName represents an object containing the footballers name

type NestedTestData

type NestedTestData struct {
	Team       string            `avro:"team"`
	Footballer FootballerName    `avro:"footballer"`
	Stats      int32             `avro:"stats"`
	AKA        map[string]string `avro:"aka"`
	Silverware map[string]string `avro:"silverware"`
}

NestedTestData represents an object nested within an object

type Schema

type Schema struct {
	Definition string
}

Schema contains the schema definition necessary to generate an avro record

func (*Schema) Marshal

func (schema *Schema) Marshal(s interface{}) ([]byte, error)

Marshal is used to avro encode the interface of s.

func (*Schema) Unmarshal

func (schema *Schema) Unmarshal(message []byte, s interface{}) error

Unmarshal is used to parse the avro encoded data and store the result in the value pointed to by s.