log

type BinaryReader struct {
	io.Reader
	// contains filtered or unexported fields
}

type BinaryWriter struct {
	io.Writer
	// contains filtered or unexported fields
}

type ByStartOffset []Segment

type Config struct {
	MaxSegmentSize int64
	MaxSyncLag     int
}

type Consumer struct {
	// contains filtered or unexported fields
}

type Log struct {
	// contains filtered or unexported fields
}

type Message struct {
	// 4 byte CRC32 of the message
	CRC uint32
	// 1 byte "magic" identifier to allow format changes, value is 0 or 1
	Format byte
	// 1 byte "attributes" identifier to allow annotations on the message independent
	//   bit 0 ~ 2 : Compression codec.
	//      0 : no compression
	//      1 : gzip
	//      2 : snappy
	//      3 : lz4
	//    bit 3 : Timestamp type
	//      0 : create time
	//      1 : log append time
	//    bit 4 ~ 7 : reserved
	Attributes byte
	// (Optional) 8 byte timestamp only if "magic" identifier is greater than 0
	Timestamp uint64
	// K byte key
	Key []byte
	// V byte payload
	Payload []byte
}

type Reader struct {
	ReaderBackend
	// contains filtered or unexported fields
}

type ReaderBackend interface {
	io.Reader
	io.Seeker
	io.Closer
}

type Segment interface {
	// The first offset of this segment (given by Store.AddSegment).
	StartOffset() uint64
	// An appender to this segment.
	Appender() (SegmentAppender, error)
	// A reader of this segment.
	Reader() (SegmentReader, error)
}

type SegmentAppender interface {
	// Append a message to the log. Returns the position after the write (aka segment size).
	Append(offset uint64, message *Message) (int64, error)
	// Flush caches to ensure data is written.
	Sync() error
	// Close the appender.
	Close() error
}

type SegmentReader interface {
	// The current position in the segment.
	Position() int64
	// Read the next message from the segment.
	// Returns the offset, the message, and any error that occured while reading.
	Next() (uint64, *Message, error)
	// Seek to a given offset
	SeekToOffset(offset uint64) error
	// Seek to the end of the segment, returning the last valid offset read.
	SeekToEnd() (uint64, error)
	// Close the reader
	Close() error
}

type Store interface {
	// The current list of segments in the store.
	Segments() ([]Segment, error)
	// Add a new segment to the store.
	AddSegment(startOffset uint64) (Segment, error)
}

type Writer struct {
	WriterBackend
	// contains filtered or unexported fields
}

type WriterBackend interface {
	io.Writer
	io.Seeker
	io.Closer

	Sync() error
}