coder

Documentation

Index

• Constants
• Variables
• func ParseRevision(revisionBytes []byte) (rev uint64, isTombStone bool, err error)
• type Coder
  • func NewNormalCoder() Coder

Constants

const (
	RevisionValueLength                 = 8
	RevisionValueLengthWithDeletionFlag = 9
)

Variables

var (
	ErrInvalidRevFormat = errors.New("invalid format of revision bytes")
)

Functions

func ParseRevision

func ParseRevision(revisionBytes []byte) (rev uint64, isTombStone bool, err error)

ParseRevision parses revision bytes

Types

type Coder

type Coder interface {
	// EncodeObjectKey encodes user key to internal object key
	EncodeObjectKey(key []byte, revision uint64) []byte

	// EncodeRevisionKey encodes user key to internal revision key
	// todo: deprecated
	EncodeRevisionKey(key []byte) []byte

	// Decode decodes internal key to user key and revision
	Decode(internalKey []byte) (userKey []byte, revision uint64, err error)
}

Coder defines the interface that transforms user key to and from internal key

func NewNormalCoder

func NewNormalCoder() Coder