Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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
- API
  
  Reference documentation for the pkg.go.dev API
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

spool

package module

Go to main page

Versions in this module

v0

v0.1.0

Jul 29, 2026

Changes in this version

+ const DefaultMaxBytes

+ const DefaultSegmentBytes

+ const MaxRecordBytes

+ const Unbounded

+ var ErrClosed = errors.New("spool: closed")

+ var ErrExceedsCap = fmt.Errorf("%w: record exceeds MaxBytes", ErrFull)

+ var ErrGroupLost = errors.New("spool: unsynced records lost; re-append the group")

+ var ErrRecordTooLarge = errors.New("spool: record exceeds MaxRecordBytes")

type Options

+ CommitSync bool

type Spool

+ func (s *Spool) CursorErr() error

+ func (s *Spool) Requeue(data []byte, commit func()) (rotated bool, err error)

+ func (s *Spool) Stats() Stats

+ type Stats struct

+ Appended uint64

+ BacklogBytes int64

+ Committed uint64

+ CursorErrors uint64

+ DiscardedBytes int64

+ DiskBytes int64

+ ForeignBytes uint64

+ ForeignSegments uint64

+ Full uint64

+ LostBytes uint64

+ LostSegments uint64

+ MaxBytes int64

+ Popped uint64

+ Segments int

+ UnsyncedBytes int64

v0.0.1

Jul 29, 2026

Changes in this version

+ const FrameOverhead

+ var ErrCorrupt = errors.New("spool: corrupt")

+ var ErrFull = errors.New("spool: full")

+ type Options struct

+ MaxBytes int64

+ SegmentBytes int64

+ type Spool struct

+ func Open(dir string, opts Options) (*Spool, error)

+ func (s *Spool) Append(data []byte) error

+ func (s *Spool) AppendForce(data []byte) error

+ func (s *Spool) AppendNoSync(data []byte) error

+ func (s *Spool) Bytes() int64

+ func (s *Spool) Cap() int64

+ func (s *Spool) Close() error

+ func (s *Spool) Discarded() int64

+ func (s *Spool) Pop() (data []byte, commit func(), ok bool, err error)

+ func (s *Spool) Segments() int

+ func (s *Spool) Signal() <-chan struct{}

+ func (s *Spool) Sync() error