# README
Commit log
This commit log implementation is forked from the liftbridge-io/liftbridge project created by Tyler Treat. All other files from the original repository have been removed here.
Changes
- removed all code & dependencies unrelated to the commit log
- removed all proto definitions unrelated to the commit log
# Functions
New creates a new CommitLog and starts a background goroutine which periodically checkpoints the high watermark to disk.
# Variables
ErrCommitLogClosed is returned when attempting to read from a commit log that has been closed.
ErrCommitLogDeleted is returned when attempting to read from a commit log that has been deleted.
ErrCommitLogReadonly is returned when the end of a readonly CommitLog has been reached.
ErrEntryNotFound is returned when a segment search cannot find a specific entry.
ErrIncorrectOffset is returned if the offset is incorrect.
ErrSegmentClosed is returned on reads/writes to a closed segment.
ErrSegmentExists is returned when attempting to create a segment that already exists.
ErrSegmentNotFound is returned if the segment could not be found.
ErrSegmentReplaced is returned when attempting to read from a segment that has been replaced due to log compaction.
# Interfaces
CommitLog is the durable write-ahead log interface used to back each stream.
# Type aliases
SerializedMessage is a serialized message read from the log.