v2

Documentation

Index

• Constants
• func NewDataReader(r backend.ContextReader, encoding backend.Encoding) (common.DataReader, error)
• func NewDataWriter(writer io.Writer, encoding backend.Encoding) (common.DataWriter, error)
• func NewIndexReader(r backend.ContextReader, pageSizeBytes int, totalRecords int) (common.IndexReader, error)
• func NewIndexWriter(pageSizeBytes int) common.IndexWriter
• func NewObjectReaderWriter() common.ObjectReaderWriter
• func NewRecordReaderWriter() common.RecordReaderWriter

Constants

const DataHeaderLength = 0

DataHeaderLength is the length in bytes for the data header

const IndexHeaderLength = int(uint64Size) // 64bit checksum (xxhash)

IndexHeaderLength is the length in bytes for the record header

Functions

func NewDataReader

func NewDataReader(r backend.ContextReader, encoding backend.Encoding) (common.DataReader, error)

NewDataReader constructs a v2 DataReader that handles paged...reading

func NewDataWriter

func NewDataWriter(writer io.Writer, encoding backend.Encoding) (common.DataWriter, error)

NewDataWriter creates a paged page writer

func NewIndexReader

func NewIndexReader(r backend.ContextReader, pageSizeBytes int, totalRecords int) (common.IndexReader, error)

NewIndexReader returns an index reader for a byte slice of marshalled ordered records. The index has not changed between v0 and v1.

func NewIndexWriter

func NewIndexWriter(pageSizeBytes int) common.IndexWriter

NewIndexWriter returns an index writer that writes to the provided io.Writer. The index has not changed between v0 and v1.

func NewObjectReaderWriter

func NewObjectReaderWriter() common.ObjectReaderWriter

func NewRecordReaderWriter

func NewRecordReaderWriter() common.RecordReaderWriter