gen

Documentation

Overview

Package gen allows generating Go structs from avro schemas.

Index

• func Struct(s string, w io.Writer, cfg Config) error
• func StructFromSchema(schema avro.Schema, w io.Writer, cfg Config) error
• type Config
• type Generator
  • func NewGenerator(pkg string, tags map[string]TagStyle, opts ...OptsFunc) *Generator
  • func (g *Generator) Parse(schema avro.Schema)
  • func (g *Generator) Reset()
  • func (g *Generator) Write(w io.Writer) error
• type OptsFunc
  • func WithEncoders(b bool) OptsFunc
  • func WithFullName(b bool) OptsFunc
  • func WithInitialisms(ss []string) OptsFunc
• type TagStyle

Functions

func Struct

func Struct(s string, w io.Writer, cfg Config) error

Struct generates Go structs based on the schema and writes them to w.

func StructFromSchema

func StructFromSchema(schema avro.Schema, w io.Writer, cfg Config) error

StructFromSchema generates Go structs based on the schema and writes them to w.

Types

type Config

type Config struct {
	PackageName string
	Tags        map[string]TagStyle
	FullName    bool
	Encoders    bool
	Initialisms []string
}

Config configures the code generation.

type Generator

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

Generator generates Go structs from schemas.

func NewGenerator

func NewGenerator(pkg string, tags map[string]TagStyle, opts ...OptsFunc) *Generator

NewGenerator returns a generator.

func (*Generator) Parse

func (g *Generator) Parse(schema avro.Schema)

Parse parses an avro schema into Go types.

func (*Generator) Reset

func (g *Generator) Reset()

Reset reset the generator.

func (*Generator) Write

func (g *Generator) Write(w io.Writer) error

Write writes Go code from the parsed schemas.

type OptsFunc

type OptsFunc func(*Generator)

OptsFunc is a function that configures a generator.

func WithEncoders

func WithEncoders(b bool) OptsFunc

WithEncoders configures the generator to generate schema and encoders on all objects.

func WithFullName

func WithFullName(b bool) OptsFunc

WithFullName configures the generator to use the full name of a record when creating the struct name.

func WithInitialisms

func WithInitialisms(ss []string) OptsFunc

WithInitialisms configures the generator to use additional custom initialisms when styling struct and field names.

type TagStyle

type TagStyle string

TagStyle defines the styling for a tag.

const (
	// Original is a style like whAtEVer_IS_InthEInpuT.
	Original TagStyle = "original"
	// Snake is a style like im_written_in_snake_case.
	Snake TagStyle = "snake"
	// Camel is a style like imWrittenInCamelCase.
	Camel TagStyle = "camel"
	// Kebab is a style like im-written-in-kebab-case.
	Kebab TagStyle = "kebab"
	// UpperCamel is a style like ImWrittenInUpperCamel.
	UpperCamel TagStyle = "upper-camel"
)