Breaking Changes
Reader, Writer, and Encoder are now concrete types, not interfaces.
// Before
var r seekable.Reader
r, err = seekable.NewReader(rs, dec)
// After
var r *seekable.Reader
r, err = seekable.NewReader(rs, dec)NewWriter now returns *Writer; ConcurrentWriter was removed. Use *Writer directly for Write, WriteMany, and Close.
// Before
var w seekable.ConcurrentWriter
w, err = seekable.NewWriter(dst, enc)
// After
var w *seekable.Writer
w, err = seekable.NewWriter(dst, enc)Decoder and NewDecoder were removed. Use NewSeekTable for byte-oriented seek-table inspection.
// Before
d, err := seekable.NewDecoder(seekTableFrame, dec)
entry := d.GetIndexByDecompOffset(off)
size := d.Size()
// After
table, err := seekable.NewSeekTable(seekTableFrame)
entry, ok := table.EntryByDecompressedOffset(off)
size := table.Size()Reader seek-table inspection moved from Decoder-style methods to Reader.SeekTable.
// Before
entry := d.GetIndexByID(id)
n := d.NumFrames()
// After
table, err := r.SeekTable()
entry, ok := table.EntryByID(id)
n := table.NumFrames()The env subpackage was removed. Environment interfaces and frame metadata now live in the main package.
// Before
import "github.com/SaveTheRbtz/zstd-seekable-format-go/pkg/env"
func (e customEnv) GetFrameByIndex(entry env.FrameOffsetEntry) ([]byte, error)
// After
func (e customEnv) GetFrameByIndex(entry seekable.FrameOffsetEntry) ([]byte, error)FrameOffsetEntry field names changed to full names.
// Before
entry.CompOffset
entry.DecompOffset
entry.CompSize
entry.DecompSize
// After
entry.CompressedOffset
entry.DecompressedOffset
entry.CompressedSize
entry.DecompressedSizeReader and writer option names were expanded.
// Before
seekable.WithRLogger(logger)
seekable.WithREnvironment(env)
seekable.WithWLogger(logger)
seekable.WithWEnvironment(env)
// After
seekable.WithReaderLogger(logger)
seekable.WithReaderEnvironment(env)
seekable.WithWriterLogger(logger)
seekable.WithWriterEnvironment(env)Option types were renamed.
// Before
func custom(o *seekable.rOption) {} // or seekable.wOption usage
// After
var ro seekable.ReaderOption
var wo seekable.WriterOptionWithWriteCallback now receives full frame metadata instead of only compressed size.
// Before
seekable.WithWriteCallback(func(size uint32) {
written += uint64(size)
})
// After
seekable.WithWriteCallback(func(entry seekable.FrameOffsetEntry) {
written += uint64(entry.CompressedSize)
})NewReader, NewWriter, and NewEncoder now use the renamed option types and return concrete pointers.
// Before
r, err := seekable.NewReader(rs, dec, seekable.WithRLogger(logger))
e, err := seekable.NewEncoder(enc, seekable.WithWLogger(logger))
// After
r, err := seekable.NewReader(rs, dec, seekable.WithReaderLogger(logger))
e, err := seekable.NewEncoder(enc, seekable.WithWriterLogger(logger))What's Changed
- cmd/zstdseek: bump pkg to v0.9.0 by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/237
- go: enable race detector in tests by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/239
- pkg: validate seek table entry count by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/240
- pkg: support zero-sized frames and improve perf by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/238
- pkg: handle short ReaderAt reads by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/241
- pkg: replace Decoder with SeekTable by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/242
- tests: simplify pkg coverage by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/244
- pkg: define reader post-close errors by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/245
- pkg: release writer index on close by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/246
- ci: add typos check by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/247
- go: remove toolchain directives by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/248
- ci: scan workflows with typos by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/249
- pkg: simplify checksum casts by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/250
- pkg: improve godoc comments by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/251
- pkg: export SeekTable type by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/252
- pkg: improve godoc comments by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/253
- writer: stop after failed frame writes by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/254
- writer: return WriteMany cancellation errors by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/243
- reader: match writer frame size limit by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/255
- ci: harden workflow token permissions by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/256
- ci: pin workflow actions by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/257
- ci: publish OpenSSF Scorecard results by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/258
- pkg: standardize lifecycle finalization by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/259
- pkg: rename public option API by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/261
- cmd: bump package dependency by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/262
- cmd: replace zap with slog by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/263
- pkg: return concrete types by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/264
- pkg: expose reader seek table by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/265
- readme: streamline package overview by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/267
- docs: polish package godoc by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/266
- pkg: expand writemany write callback by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/268
- pkg: preserve reader offset on eof by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/269
- pkg: short-circuit empty reader reads by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/270
- pkg: stop writemany after cancellation by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/271
- pkg: bound footer parse errors by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/273
- cmd: bump zstdseek pkg dependency by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/272
- pkg: add pluggable frame cache by @SaveTheRbtz in https://github.com/SaveTheRbtz/zstd-seekable-format-go/pull/274
Full Changelog: https://github.com/SaveTheRbtz/zstd-seekable-format-go/compare/pkg/v0.9.0...pkg/v0.10.0-rc.1