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
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

wal

package module

Go to main page

Versions in this module

v0

v0.1.2

Feb 11, 2026

v0.1.1

Feb 3, 2026

v0.1.0

Feb 2, 2026

Changes in this version

+ const B

+ const GB

+ const KB

+ const MB

+ var DefaultOptions = Options

+ var ErrClosed = errors.New("the segment file is closed")

+ var ErrInvalidCrc32 = errors.New("invalid CRC, the data may be corrupted")

+ var ErrPendingSizeTooLarge = errors.New("the upper bound of pending writes can't be larger than segment size")

+ var ErrValueTooLarge = errors.New("the data size can't be larger than segment size")

+ func SegmentFileName(dirPath, extName string, id uint32) string

+ type ChunkPosition struct

+ BlockNumber uint32

+ ChunkOffset int64

+ ChunkSize uint32

+ SegmentId SegmentId

+ func DecodeChunkPosition(buf []byte) *ChunkPosition

+ func (cp *ChunkPosition) Encode() []byte

+ func (cp *ChunkPosition) EncodeFixedSize() []byte

+ type ChunkType = byte

+ const ChunkTypeFirst

+ const ChunkTypeFull

+ const ChunkTypeLast

+ const ChunkTypeMiddle

+ type Options struct

+ BytesPerSync uint32

+ DirPath string

+ SegmentFileExt string

+ SegmentSize int64

+ Sync bool

+ SyncInterval time.Duration

+ type Reader struct

+ func (r *Reader) CurrentChunkPosition() *ChunkPosition

+ func (r *Reader) CurrentSegmentId() SegmentId

+ func (r *Reader) Next() ([]byte, *ChunkPosition, error)

+ func (r *Reader) SkipCurrentSegment()

+ type SegmentId = uint32

+ type Wal struct

+ func Open(opt Options) (*Wal, error)

+ func (wal *Wal) ActiveSegmentId() SegmentId

+ func (wal *Wal) AddPendingWrites(data []byte)

+ func (wal *Wal) ClearPendingWrites()

+ func (wal *Wal) Close() error

+ func (wal *Wal) Delete() error

+ func (wal *Wal) IsEmpty() bool

+ func (wal *Wal) IsFull(size int64) bool

+ func (wal *Wal) NewReader() *Reader

+ func (wal *Wal) NewReaderWithMax(segId SegmentId) *Reader

+ func (wal *Wal) NewReaderWithStart(startPos *ChunkPosition) (*Reader, error)

+ func (wal *Wal) OpenNewActiveSegment() error

+ func (wal *Wal) Read(pos *ChunkPosition) ([]byte, error)

+ func (wal *Wal) RenameFileExt(ext string) error

+ func (wal *Wal) SetIsStartupTraversal(val bool)

+ func (wal *Wal) Sync() error

+ func (wal *Wal) Write(data []byte) (*ChunkPosition, error)

+ func (wal *Wal) WriteAll() ([]*ChunkPosition, error)