wal

May 15, 2025

Changes in this version

+ const CrcType

+ const EntryType

+ const MetadataType

+ const SnapshotType

+ const StateType

+ var ErrCRCMismatch = walpb.ErrCRCMismatch

+ var ErrDecoderNotFound = errors.New("wal: decoder not found")

+ var ErrFileNotFound = errors.New("wal: file not found")

+ var ErrMetadataConflict = errors.New("wal: conflicting metadata found")

+ var ErrSliceOutOfRange = errors.New("wal: slice bounds out of range")

+ var ErrSnapshotMismatch = errors.New("wal: snapshot mismatch")

+ var ErrSnapshotNotFound = errors.New("wal: snapshot not found")

+ var SegmentSizeBytes int64 = 64 * 1000 * 1000

+ func Exist(dir string) bool

+ func MinimalEtcdVersion(ents []raftpb.Entry) *semver.Version

+ func MustUnmarshalEntry(d []byte) raftpb.Entry

+ func MustUnmarshalState(d []byte) raftpb.HardState

+ func Repair(lg *zap.Logger, dirpath string) bool

+ func ValidSnapshotEntries(lg *zap.Logger, walDir string) ([]walpb.Snapshot, error)

+ func Verify(lg *zap.Logger, walDir string, snap walpb.Snapshot) (*raftpb.HardState, error)

+ func VisitFileDescriptor(file protoreflect.FileDescriptor, visitor Visitor) error

+ type Decoder interface

+ Decode func(rec *walpb.Record) error

+ LastCRC func() uint32

+ LastOffset func() int64

+ UpdateCRC func(prevCrc uint32)

+ func NewDecoder(r ...fileutil.FileReader) Decoder

+ func NewDecoderAdvanced(continueOnCrcError bool, r ...fileutil.FileReader) Decoder

+ type Version interface

+ MinimalEtcdVersion func() *semver.Version

+ func ReadWALVersion(w *WAL) (Version, error)

+ type Visitor func(path protoreflect.FullName, ver *semver.Version) error

+ type WAL struct

+ func Create(lg *zap.Logger, dirpath string, metadata []byte) (*WAL, error)

+ func Open(lg *zap.Logger, dirpath string, snap walpb.Snapshot) (*WAL, error)

+ func OpenForRead(lg *zap.Logger, dirpath string, snap walpb.Snapshot) (*WAL, error)

+ func (w *WAL) Close() error

+ func (w *WAL) ReadAll() (metadata []byte, state raftpb.HardState, ents []raftpb.Entry, err error)

+ func (w *WAL) ReleaseLockTo(index uint64) error

+ func (w *WAL) Reopen(lg *zap.Logger, snap walpb.Snapshot) (*WAL, error)

+ func (w *WAL) Save(st raftpb.HardState, ents []raftpb.Entry) error

+ func (w *WAL) SaveSnapshot(e walpb.Snapshot) error

+ func (w *WAL) SetUnsafeNoFsync()

+ func (w *WAL) Sync() error