segment

package

v0.1.0 Latest Latest Go to latest Published: Nov 9, 2019 License: MIT Imports: 3 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

Package segment provides the data segment.

View Source

const (
	Uint8Size = 1 << iota
	Uint16Size
	Uint32Size
	Uint64Size
)

Sizes of the unsigned integer types in bytes.

View Source

var ErrUnknown = fmt.Errorf("segment: unknown value")

ErrUnknown is the error which returns when the given value has an unknown type.

This section is empty.

type ReadWriterAt interface {
	io.ReaderAt
	io.WriterAt
}

ReadWriterAt is the interface that groups the basic io.ReadAt and io.WriteAt methods.

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

Segment is a data segment. The supported data types are uint8, uint16, uint32 and uint64. All numeric values stored in the big-endian byte order.

func New(driver ReadWriterAt) *Segment

New returns a new data segment based on the given data access driver.

func (seg *Segment) Dec(offset int64, d ...interface{}) error

Dec sequentially decreases values starting from the given offset using deltas specified by d.

func (seg *Segment) Get(offset int64, v ...interface{}) error

Get sequentially reads values pointed by v starting from the given offset.

func (seg *Segment) Inc(offset int64, d ...interface{}) error

Inc sequentially increases values starting from the given offset using deltas specified by d.

func (seg *Segment) Set(offset int64, v ...interface{}) error

Set sequentially writes values specified by v starting from the given offset.

func (seg *Segment) Swap(offset int64, v ...interface{}) error

Swap sequentially swaps values pointed by v with stored ones starting from the given offset.