entry

package

v0.4.1 Latest Latest Go to latest Published: Dec 14, 2023 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

Repository

github.com/246859/river

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CheckEntryType(t EType) error
func IsExpired(ttl int64) bool
func LeftTTl(ttl int64) time.Duration
func MarshalEntry(entry Entry) ([]byte, error)
func MarshalHeader(header Header) ([]byte, int, error)
func NewTTL(ttl time.Duration) int64
func Validate(entry Entry) error
type BinaryEntry
- func (d BinaryEntry) MarshalEntry(entry Entry) ([]byte, error)
- func (d BinaryEntry) MarshalHeader(header Header) ([]byte, int, error)
- func (d BinaryEntry) UnMarshalEntry(bytes []byte) (Entry, error)
- func (d BinaryEntry) UnMarshalHeader(raws []byte) (Header, int, error)
type EType
type Entry
- func UnMarshalEntry(rawdata []byte) (Entry, error)
type Header
- func UnMarshalHeader(rawdata []byte) (Header, int, error)
type HeaderMarshaler
type HeaderUnmarshaler
type Marshaler
type Serializer
type UnMarshaler

Constants ¶

View Source

const MaxHeaderSize = 1 + binary.MaxVarintLen64*2 + binary.MaxVarintLen32*2

MaxHeaderSize | 31 B | +------+------+----------+--------+----------+---------+---------+ | type | ttl | txn_id | key_sz | value_sz | key | value | +------+------+----------+--------+----------+---------+---------+ | 1 B | 10 B | 10 B | 5 B | 5 B | unfixed | unfixed | +------+------+----------+--------+----------+---------+---------+

Variables ¶

View Source

var (
	ErrNilKey             = errors.New("key is nil")
	ErrNilRawData         = errors.New("raw data bytes is nil")
	ErrInvalidEntryType   = errors.New("entry type is invalid")
	ErrRedundantEntryType = errors.New("redundant entry type")
	ErrExpired            = errors.New("entry is expired")
)

Functions ¶

func CheckEntryType ¶

func CheckEntryType(t EType) error

func IsExpired ¶

func IsExpired(ttl int64) bool

IsExpired if ttl is 0, represents of persistent only if ttl > 0, entry has live time

func LeftTTl ¶

func LeftTTl(ttl int64) time.Duration

func MarshalEntry ¶

func MarshalEntry(entry Entry) ([]byte, error)

func MarshalHeader ¶

func MarshalHeader(header Header) ([]byte, int, error)

func NewTTL ¶

func NewTTL(ttl time.Duration) int64

func Validate ¶

func Validate(entry Entry) error

Validate validates the given entry if is a valid data entry

Types ¶

type BinaryEntry ¶

type BinaryEntry struct{}

BinaryEntry Binary data format

func (BinaryEntry) MarshalEntry ¶

func (d BinaryEntry) MarshalEntry(entry Entry) ([]byte, error)

func (BinaryEntry) MarshalHeader ¶

func (d BinaryEntry) MarshalHeader(header Header) ([]byte, int, error)

func (BinaryEntry) UnMarshalEntry ¶

func (d BinaryEntry) UnMarshalEntry(bytes []byte) (Entry, error)

func (BinaryEntry) UnMarshalHeader ¶

func (d BinaryEntry) UnMarshalHeader(raws []byte) (Header, int, error)

type EType ¶

type EType = byte

const (
	DataEntryType EType = 1 + iota

	DeletedEntryType

	TxnCommitEntryType

	TxnRollBackEntryType
)

type Entry ¶

type Entry struct {
	Type  EType
	Key   []byte
	Value []byte

	TTL  int64
	TxId int64
}

Entry represents a data entry in data file

func UnMarshalEntry ¶

func UnMarshalEntry(rawdata []byte) (Entry, error)

type Header ¶

type Header struct {
	Type EType
	TTL  int64
	TxId int64
	Ksz  uint32
	Vsz  uint32
}

Header represents a header of data entry

func UnMarshalHeader ¶

func UnMarshalHeader(rawdata []byte) (Header, int, error)

type HeaderMarshaler ¶

type HeaderMarshaler interface {
	MarshalHeader(entry Header) ([]byte, int, error)
}

type HeaderUnmarshaler ¶

type HeaderUnmarshaler interface {
	UnMarshalHeader(raws []byte) (Header, int, error)
}

type Marshaler ¶

type Marshaler interface {
	MarshalEntry(entry Entry) ([]byte, error)
}

type Serializer ¶

type Serializer interface {
	Marshaler
	UnMarshaler
	HeaderMarshaler
	HeaderUnmarshaler
}

type UnMarshaler ¶

type UnMarshaler interface {
	UnMarshalEntry(raws []byte) (Entry, error)
}

Source Files ¶

View all Source files

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