entry

package

v0.2.3 Latest Latest Go to latest Published: Nov 6, 2023 License: Apache-2.0 Imports: 4 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

This section is empty.

This section is empty.

This section is empty.

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

Batch of entries.

func NewBatch(capacity int) Batch

NewBatch with capacity.

func (b *Batch) Append(e Entry)

Append an entry.

func (b *Batch) Len() int

Len is number of entries inside Batch.

func (b *Batch) Marshal(w io.Writer, format common.EntryFormat) (code common.ErrCode, err error)

Marshal into writer.

func (b *Batch) Reset()

Reset batch.

func (b *Batch) ValidateSize(size int) bool

ValidateSize checks size of entries.

type Entry []byte

Entry represents queue entry.

func (e *Entry) CloneFrom(other Entry)

CloneFrom other entry.

func (e Entry) Marshal(w io.Writer, format common.EntryFormat) (code common.ErrCode, err error)

Marshal writes entry to writer.

func (e *Entry) Unmarshal(r io.Reader, format common.EntryFormat) (common.ErrCode, int, error)

Unmarshal from reader.

type Reader interface {
	io.Closer
	io.Seeker
	ReadEntry(*Entry) (common.ErrCode, int, error)
}

Reader interface.

type Writer interface {
	io.Closer
	WriteEntry(Entry) (common.ErrCode, error)
	WriteBatch(Batch) (common.ErrCode, error)
}

Writer interface.