chunks

Documentation

Index

• Constants
• type ByteSlice
• type Meta
  • func (cm *Meta) OverlapsClosedInterval(mint, maxt int64) bool
• type Reader
  • func NewDirReader(dir string, pool chunkenc.Pool) (*Reader, error)
  • func NewReader(bs []ByteSlice, pool chunkenc.Pool) (*Reader, error)
  • func (s *Reader) Chunk(ref uint64) (chunkenc.Chunk, error)
  • func (s *Reader) Close() error
• type Writer
  • func NewWriter(dir string) (*Writer, error)
  • func (w *Writer) Close() error
  • func (w *Writer) WriteChunks(chks ...Meta) error

Constants

const (
	// MagicChunks is 4 bytes at the head of a series file.
	MagicChunks = 0x85BD40DD
)

Types

type ByteSlice

type ByteSlice interface {
	Len() int
	Range(start, end int) []byte
}

ByteSlice abstracts a byte slice.

type Meta

type Meta struct {
	// Ref and Chunk hold either a reference that can be used to retrieve
	// chunk data or the data itself.
	// Generally, only one of them is set.
	Ref   uint64
	Chunk chunkenc.Chunk

	MinTime, MaxTime int64 // time range the data covers
}

Meta holds information about a chunk of data.

func (*Meta) OverlapsClosedInterval

func (cm *Meta) OverlapsClosedInterval(mint, maxt int64) bool

Returns true if the chunk overlaps [mint, maxt].

type Reader

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

Reader implements a SeriesReader for a serialized byte stream of series data.

func NewDirReader

func NewDirReader(dir string, pool chunkenc.Pool) (*Reader, error)

NewDirReader returns a new Reader against sequentially numbered files in the given directory.

func NewReader

func NewReader(bs []ByteSlice, pool chunkenc.Pool) (*Reader, error)

NewReader returns a new chunk reader against the given byte slices.

func (*Reader) Chunk

func (s *Reader) Chunk(ref uint64) (chunkenc.Chunk, error)

func (*Reader) Close

func (s *Reader) Close() error

type Writer

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

Writer implements the ChunkWriter interface for the standard serialization format.

func NewWriter

func NewWriter(dir string) (*Writer, error)

NewWriter returns a new writer against the given directory.

func (*Writer) Close

func (w *Writer) Close() error

func (*Writer) WriteChunks

func (w *Writer) WriteChunks(chks ...Meta) error