message

package

v0.6.0 Latest Latest Go to latest Published: Apr 22, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/klev-dev/klevdb

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Size(m Message) int64
func ValidateOffset(offset int64) error
type Message
- func Gen(count int) []Message
type Reader
- func OpenReader(path string) (*Reader, error)
- func OpenReaderMem(path string) (*Reader, error)
type Writer
- func OpenWriter(path string) (*Writer, error)

Constants ¶

View Source

const (
	// OffsetOldest represents the smallest offset still available
	// Use it to consume all messages, starting at the first available
	OffsetOldest int64 = -2
	// OffsetNewest represents the offset that will be used for the next produce
	// Use it to consume only new messages
	OffsetNewest int64 = -1
	// OffsetInvalid is the offset returned when error is detected
	OffsetInvalid int64 = -3
)

Variables ¶

View Source

var ErrCorrupted = errors.New("message corrupted")

View Source

var ErrInvalidOffset = errors.New("invalid offset")

View Source

var ErrNotFound = errors.New("not found")

View Source

var Invalid = Message{Offset: OffsetInvalid}

Functions ¶

func Size ¶

func Size(m Message) int64

func ValidateOffset ¶

func ValidateOffset(offset int64) error

Types ¶

type Message ¶

type Message struct {
	Offset int64
	Time   time.Time
	Key    []byte
	Value  []byte
}

func Gen ¶

func Gen(count int) []Message

type Reader ¶

type Reader struct {
	Path string
	// contains filtered or unexported fields
}

func OpenReader ¶

func OpenReader(path string) (*Reader, error)

func OpenReaderMem ¶

func OpenReaderMem(path string) (*Reader, error)

func (*Reader) Close ¶

func (r *Reader) Close() error

func (*Reader) Consume ¶

func (r *Reader) Consume(position, maxPosition int64, maxCount int64) ([]Message, error)

func (*Reader) Get ¶

func (r *Reader) Get(position int64) (msg Message, err error)

func (*Reader) Read ¶

func (r *Reader) Read(position int64) (msg Message, nextPosition int64, err error)

type Writer ¶

type Writer struct {
	Path string
	// contains filtered or unexported fields
}

func OpenWriter ¶

func OpenWriter(path string) (*Writer, error)

func (*Writer) Close ¶

func (w *Writer) Close() error

func (*Writer) Size ¶

func (w *Writer) Size() int64

func (*Writer) Sync ¶

func (w *Writer) Sync() error

func (*Writer) SyncAndClose ¶

func (w *Writer) SyncAndClose() error

func (*Writer) Write ¶

func (w *Writer) Write(m Message) (int64, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL