chunkaligned

README

chunkaligned

Summary

NewChunkAlignedReaderAt returns a ReaderAt wrapper that is backed by a ReaderAt r of size totalSize where the wrapper guarantees that all ReadAt calls are aligned to chunkSize boundaries and of size chunkSize (except for the final chunk, which may be shorter).

A chunk-aligned reader is good for caching, letting upper layers have any access pattern, but guarantees that the wrapped ReaderAt sees only nicely-cacheable access patterns & sizes.

Usage

For API docs and examples, see tests.

Documentation

Index

• type SizeReaderAt
  • func NewChunkAlignedReaderAt(r SizeReaderAt, chunkSize int) (SizeReaderAt, error)

Types

type SizeReaderAt

type SizeReaderAt interface {
	Size() int64
	io.ReaderAt
}

An io.SectionReader implements SizeReaderAt.

func NewChunkAlignedReaderAt

func NewChunkAlignedReaderAt(r SizeReaderAt, chunkSize int) (SizeReaderAt, error)

NewChunkAlignedReaderAt returns a ReaderAt wrapper that is backed by a ReaderAt r of size totalSize where the wrapper guarantees that all ReadAt calls are aligned to chunkSize boundaries and of size chunkSize (except for the final chunk, which may be shorter).

A chunk-aligned reader is good for caching, letting upper layers have any access pattern, but guarantees that the wrapped ReaderAt sees only nicely-cacheable access patterns & sizes.