Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

base

package

Go to main page

Versions in this module

v1

v1.2.12

Dec 23, 2023

v1.2.11

Dec 23, 2023

v1.2.10

Dec 22, 2023

v1.2.3

Dec 22, 2023

v1.2.2

Dec 22, 2023

v1.2.1

Dec 22, 2023

v1.2.0

Dec 22, 2023

Changes in this version

+ type Marshaler interface

+ MarshalAvro func() ([]byte, error)

type Type

+ const Raw

+ type Unmarshaler interface

+ UnmarshalAvro func(p []byte) error

v1.1.1

Dec 21, 2023

v1.1.0

Dec 21, 2023

v1.0.0

Dec 21, 2023

Changes in this version

+ var DefaultConfig = Config{}.Freeze()

+ var DefaultSchemaCache = &SchemaCache

+ var NoDefault = noDef

+ func Marshal(schema Schema, v any) ([]byte, error)

+ func Register(name string, obj any)

+ func RegisterSchemaByValue(v any)

+ func Unmarshal(schema Schema, data []byte, v any) error

+ type API interface

+ DecoderOf func(schema Schema, typ reflect2.Type) ValDecoder

+ EncoderOf func(schema Schema, tpy reflect2.Type) ValEncoder

+ Marshal func(schema Schema, v any) ([]byte, error)

+ NewDecoder func(schema Schema, r io.Reader) *Decoder

+ NewEncoder func(schema Schema, w io.Writer) *Encoder

+ Register func(name string, obj any)

+ Unmarshal func(schema Schema, data []byte, v any) error

+ type ArraySchema struct

+ func NewArraySchema(items Schema, opts ...SchemaOption) *ArraySchema

+ func (p ArraySchema) Prop(name string) any

+ func (s *ArraySchema) Fingerprint() [32]byte

+ func (s *ArraySchema) FingerprintUsing(typ FingerprintType) ([]byte, error)

+ func (s *ArraySchema) Items() Schema

+ func (s *ArraySchema) MarshalJSON() ([]byte, error)

+ func (s *ArraySchema) String() string

+ func (s *ArraySchema) Type() Type

+ type Config struct

+ BlockLength int

+ DisableBlockSizeHeader bool

+ DisableCaching bool

+ MaxByteSliceSize int

+ PartialUnionTypeResolution bool

+ TagKey string

+ UnionResolutionError bool

+ func (c Config) Freeze() API

+ type DecimalLogicalSchema struct

+ func NewDecimalLogicalSchema(prec, scale int) *DecimalLogicalSchema

+ func (s *DecimalLogicalSchema) Precision() int

+ func (s *DecimalLogicalSchema) Scale() int

+ func (s *DecimalLogicalSchema) String() string

+ func (s *DecimalLogicalSchema) Type() LogicalType

+ type Decoder struct

+ func NewDecoder(s string, r io.Reader) (*Decoder, error)

+ func NewDecoderForSchema(schema Schema, reader io.Reader) *Decoder

+ func (d *Decoder) Decode(obj any) error

+ type Encoder struct

+ func NewEncoder(s string, w io.Writer) (*Encoder, error)

+ func NewEncoderForSchema(schema Schema, w io.Writer) *Encoder

+ func (e *Encoder) Encode(v any) error

+ type EnumSchema struct

+ func NewEnumSchema(name, namespace string, symbols []string, opts ...SchemaOption) (*EnumSchema, error)

+ func (n EnumSchema) Aliases() []string

+ func (n EnumSchema) FullName() string

+ func (n EnumSchema) Name() string

+ func (n EnumSchema) Namespace() string

+ func (p EnumSchema) Prop(name string) any

+ func (s *EnumSchema) Default() string

+ func (s *EnumSchema) Doc() string

+ func (s *EnumSchema) Fingerprint() [32]byte

+ func (s *EnumSchema) FingerprintUsing(typ FingerprintType) ([]byte, error)

+ func (s *EnumSchema) MarshalJSON() ([]byte, error)

+ func (s *EnumSchema) String() string

+ func (s *EnumSchema) Symbols() []string

+ func (s *EnumSchema) Type() Type

+ type Field struct

+ func NewField(name string, typ Schema, opts ...SchemaOption) (*Field, error)

+ func (f *Field) Aliases() []string

+ func (f *Field) Default() any

+ func (f *Field) Doc() string

+ func (f *Field) HasDefault() bool

+ func (f *Field) MarshalJSON() ([]byte, error)

+ func (f *Field) Name() string

+ func (f *Field) Order() Order

+ func (f *Field) String() string

+ func (f *Field) Type() Schema

+ func (p Field) Prop(name string) any

+ type FingerprintType string

+ const CRC64Avro

+ const MD5

+ const SHA256

+ type FixedSchema struct

+ func NewFixedSchema(name, namespace string, size int, logical LogicalSchema, opts ...SchemaOption) (*FixedSchema, error)

+ func (n FixedSchema) Aliases() []string

+ func (n FixedSchema) FullName() string

+ func (n FixedSchema) Name() string

+ func (n FixedSchema) Namespace() string

+ func (p FixedSchema) Prop(name string) any

+ func (s *FixedSchema) Fingerprint() [32]byte

+ func (s *FixedSchema) FingerprintUsing(typ FingerprintType) ([]byte, error)

+ func (s *FixedSchema) Logical() LogicalSchema

+ func (s *FixedSchema) MarshalJSON() ([]byte, error)

+ func (s *FixedSchema) Size() int

+ func (s *FixedSchema) String() string

+ func (s *FixedSchema) Type() Type

+ type LogicalDuration struct

+ Days uint32

+ Milliseconds uint32

+ Months uint32

+ type LogicalSchema interface

+ String func() string

+ Type func() LogicalType

+ type LogicalType string

+ const Date

+ const Decimal

+ const Duration

+ const TimeMicros

+ const TimeMillis

+ const TimestampMicros

+ const TimestampMillis

+ const UUID

+ type LogicalTypeSchema interface

+ Logical func() LogicalSchema

+ type MapSchema struct

+ func NewMapSchema(values Schema, opts ...SchemaOption) *MapSchema

+ func (p MapSchema) Prop(name string) any

+ func (s *MapSchema) Fingerprint() [32]byte

+ func (s *MapSchema) FingerprintUsing(typ FingerprintType) ([]byte, error)

+ func (s *MapSchema) MarshalJSON() ([]byte, error)

+ func (s *MapSchema) String() string

+ func (s *MapSchema) Type() Type

+ func (s *MapSchema) Values() Schema

+ type Message struct

+ func NewMessage(req *RecordSchema, resp Schema, errors *UnionSchema, oneWay bool, ...) *Message

+ func (m *Message) Doc() string

+ func (m *Message) Errors() *UnionSchema

+ func (m *Message) OneWay() bool

+ func (m *Message) Request() *RecordSchema

+ func (m *Message) Response() Schema

+ func (m *Message) String() string

+ func (p Message) Prop(name string) any

+ type NamedSchema interface

+ FullName func() string

+ Name func() string

+ Namespace func() string

+ type NullSchema struct

+ func (s *NullSchema) Fingerprint() [32]byte

+ func (s *NullSchema) FingerprintUsing(typ FingerprintType) ([]byte, error)

+ func (s *NullSchema) MarshalJSON() ([]byte, error)

+ func (s *NullSchema) String() string

+ func (s *NullSchema) Type() Type

+ type Order string

+ const Asc

+ const Desc

+ const Ignore

+ type PrimitiveLogicalSchema struct

+ func NewPrimitiveLogicalSchema(typ LogicalType) *PrimitiveLogicalSchema

+ func (s *PrimitiveLogicalSchema) String() string

+ func (s *PrimitiveLogicalSchema) Type() LogicalType

+ type PrimitiveSchema struct

+ func NewPrimitiveSchema(t Type, l LogicalSchema, opts ...SchemaOption) *PrimitiveSchema

+ func (p PrimitiveSchema) Prop(name string) any

+ func (s *PrimitiveSchema) Fingerprint() [32]byte

+ func (s *PrimitiveSchema) FingerprintUsing(typ FingerprintType) ([]byte, error)

+ func (s *PrimitiveSchema) Logical() LogicalSchema

+ func (s *PrimitiveSchema) MarshalJSON() ([]byte, error)

+ func (s *PrimitiveSchema) String() string

+ func (s *PrimitiveSchema) Type() Type

+ type PropertySchema interface

+ Prop func(string) any

+ type Protocol struct

+ func MustParseProtocol(protocol string) *Protocol

+ func NewProtocol(name, namepsace string, types []NamedSchema, messages map[string]*Message, ...) (*Protocol, error)

+ func ParseProtocol(protocol string) (*Protocol, error)

+ func ParseProtocolFile(path string) (*Protocol, error)

+ func (n Protocol) Aliases() []string

+ func (n Protocol) FullName() string

+ func (n Protocol) Name() string

+ func (n Protocol) Namespace() string

+ func (p *Protocol) Doc() string

+ func (p *Protocol) Hash() string

+ func (p *Protocol) Message(name string) *Message

+ func (p *Protocol) String() string

+ func (p *Protocol) Types() []NamedSchema

+ func (p Protocol) Prop(name string) any

+ type ProtocolOption func(*protocolConfig)

+ func WithProtoDoc(doc string) ProtocolOption

+ func WithProtoProps(props map[string]any) ProtocolOption

+ type Reader struct

+ Error error

+ func NewReader(r io.Reader, bufSize int, opts ...ReaderFunc) *Reader

+ func (r *Reader) Read(b []byte)

+ func (r *Reader) ReadArrayCB(fn func(*Reader) bool)

+ func (r *Reader) ReadBlockHeader() (int64, int64)

+ func (r *Reader) ReadBool() bool

+ func (r *Reader) ReadBytes() []byte

+ func (r *Reader) ReadDouble() float64

+ func (r *Reader) ReadFloat() float32

+ func (r *Reader) ReadInt() int32

+ func (r *Reader) ReadLong() int64

+ func (r *Reader) ReadMapCB(fn func(*Reader, string) bool)

+ func (r *Reader) ReadNext(schema Schema) any

+ func (r *Reader) ReadString() string

+ func (r *Reader) ReadVal(schema Schema, obj any)

+ func (r *Reader) ReportError(operation, msg string)

+ func (r *Reader) Reset(b []byte) *Reader

+ func (r *Reader) SkipBool()

+ func (r *Reader) SkipBytes()

+ func (r *Reader) SkipDouble()

+ func (r *Reader) SkipFloat()

+ func (r *Reader) SkipInt()

+ func (r *Reader) SkipLong()

+ func (r *Reader) SkipNBytes(n int)

+ func (r *Reader) SkipString()

+ type ReaderFunc func(r *Reader)

+ func WithReaderConfig(cfg API) ReaderFunc

+ type RecordSchema struct

+ func NewErrorRecordSchema(name, namespace string, fields []*Field, opts ...SchemaOption) (*RecordSchema, error)

+ func NewRecordSchema(name, namespace string, fields []*Field, opts ...SchemaOption) (*RecordSchema, error)

+ func (n RecordSchema) Aliases() []string

+ func (n RecordSchema) FullName() string

+ func (n RecordSchema) Name() string

+ func (n RecordSchema) Namespace() string

+ func (p RecordSchema) Prop(name string) any

+ func (s *RecordSchema) Doc() string

+ func (s *RecordSchema) Fields() []*Field

+ func (s *RecordSchema) Fingerprint() [32]byte

+ func (s *RecordSchema) FingerprintUsing(typ FingerprintType) ([]byte, error)

+ func (s *RecordSchema) IsError() bool

+ func (s *RecordSchema) MarshalJSON() ([]byte, error)

+ func (s *RecordSchema) String() string

+ func (s *RecordSchema) Type() Type

+ type RefSchema struct

+ func NewRefSchema(schema NamedSchema) *RefSchema

+ func (s *RefSchema) Fingerprint() [32]byte

+ func (s *RefSchema) FingerprintUsing(typ FingerprintType) ([]byte, error)

+ func (s *RefSchema) MarshalJSON() ([]byte, error)

+ func (s *RefSchema) Schema() NamedSchema

+ func (s *RefSchema) String() string

+ func (s *RefSchema) Type() Type

+ type Schema interface

+ Fingerprint func() [32]byte

+ FingerprintUsing func(FingerprintType) ([]byte, error)

+ String func() string

+ Type func() Type

+ func MustParse(schema string) Schema

+ func Parse(schema string) (Schema, error)

+ func ParseBytes(schema []byte) (Schema, error)

+ func ParseBytesWithCache(schema []byte, namespace string, cache *SchemaCache) (Schema, error)

+ func ParseFiles(paths ...string) (Schema, error)

+ func ParseValue(v any) (s Schema, err error)

+ func ParseWithCache(schema, namespace string, cache *SchemaCache) (Schema, error)

+ type SchemaCache struct

+ func (c *SchemaCache) Add(name string, schema Schema)

+ func (c *SchemaCache) Get(name string) Schema

+ type SchemaCompatibility struct

+ func NewSchemaCompatibility() *SchemaCompatibility

+ func (c *SchemaCompatibility) Compatible(reader, writer Schema) error

+ type SchemaOption func(*schemaConfig)

+ func WithAliases(aliases []string) SchemaOption

+ func WithDefault(def any) SchemaOption

+ func WithDoc(doc string) SchemaOption

+ func WithOrder(order Order) SchemaOption

+ func WithProps(props map[string]any) SchemaOption

+ type Schemas []Schema

+ func (s Schemas) Get(name string) (Schema, int)

+ type Type string

+ const Array

+ const Boolean

+ const Bytes

+ const Double

+ const Enum

+ const Error

+ const Fixed

+ const Float

+ const Int

+ const Long

+ const Map

+ const Null

+ const Record

+ const Ref

+ const String

+ const Union

+ type TypeResolver struct

+ func NewTypeResolver() *TypeResolver

+ func (r *TypeResolver) Name(typ reflect2.Type) ([]string, error)

+ func (r *TypeResolver) Register(name string, obj any)

+ func (r *TypeResolver) Type(name string) (reflect2.Type, error)

+ type UnionSchema struct

+ func NewUnionSchema(types []Schema) (*UnionSchema, error)

+ func (s *UnionSchema) Fingerprint() [32]byte

+ func (s *UnionSchema) FingerprintUsing(typ FingerprintType) ([]byte, error)

+ func (s *UnionSchema) Indices() (null, typ int)

+ func (s *UnionSchema) MarshalJSON() ([]byte, error)

+ func (s *UnionSchema) Nullable() bool

+ func (s *UnionSchema) String() string

+ func (s *UnionSchema) Type() Type

+ func (s *UnionSchema) Types() Schemas

+ type ValDecoder interface

+ Decode func(ptr unsafe.Pointer, r *Reader)

+ type ValEncoder interface

+ Encode func(ptr unsafe.Pointer, w *Writer)

+ type Writer struct

+ Error error

+ func NewWriter(out io.Writer, bufSize int, opts ...WriterFunc) *Writer

+ func (w *Writer) Buffer() []byte

+ func (w *Writer) Buffered() int

+ func (w *Writer) Flush() error

+ func (w *Writer) Reset(out io.Writer)

+ func (w *Writer) Write(b []byte) (int, error)

+ func (w *Writer) WriteBlockCB(callback func(w *Writer) int64) int64

+ func (w *Writer) WriteBlockHeader(l, s int64)

+ func (w *Writer) WriteBool(b bool)

+ func (w *Writer) WriteBytes(b []byte)

+ func (w *Writer) WriteDouble(f float64)

+ func (w *Writer) WriteFloat(f float32)

+ func (w *Writer) WriteInt(i int32)

+ func (w *Writer) WriteLong(i int64)

+ func (w *Writer) WriteString(s string)

+ func (w *Writer) WriteVal(schema Schema, val any)

+ type WriterFunc func(w *Writer)

+ func WithWriterConfig(cfg API) WriterFunc