goencode

goencode

Generic encoding interfaces for Go with composable codecs.

Features

• Generic Codec[T] and StreamCodec[T] interfaces with compile-time type safety
• Composable compression wrappers (gzip, flate, snappy, zstd, brotli) using the decorator pattern
• Stream support via io.Reader/io.Writer for memory-efficient pipelines
• Atomic file I/O with temp file + rename
• Zero dependencies in the core module

Installation

go get github.com/foomo/goencode

Core Interfaces

// Byte-oriented
type Codec[T any] interface {
Encode(v T) ([]byte, error)
Decode(b []byte, v *T) error
}

// Stream-oriented
type StreamCodec[T any] interface {
Encode(w io.Writer, v T) error
Decode(r io.Reader, v *T) error
}

Quick Start

// Basic JSON encode/decode
c := json.NewCodec[User]()
b, err := c.Encode(User{Name: "Alice", Age: 30})
var u User
err = c.Decode(b, &u)

// Compose with compression
c := gzip.NewCodec[User](json.NewCodec[User]())

// Add atomic file persistence
fc := file.NewCodec[User](gzip.NewCodec[User](json.NewCodec[User]()))
err := fc.Encode("/tmp/user.json.gz", user)

Available Codecs

* Submodule with separate go.mod — requires its own go get.

All codecs are safe for concurrent use.

Benchmarks

Measured with go test -bench=. -benchmem on arm64 (darwin). Results vary by hardware — use these as relative comparisons between codecs.

How to Contribute

Contributions are welcome! Please read the contributing guide.

License

Distributed under MIT License, please see the license file within the code for more details.

Made with ♥ foomo by bestbytes