sparseblock

Documentation

Index

• Constants
• Variables
• func BuildFromReader(dst io.Writer, src t.HoleReaderAt, blockSize int, opts *BuildOptions) error
• type BuildOptions
• type Builder
  • func NewBuilder(w io.Writer, blockSize int) *Builder
  • func (b *Builder) AddBlocks(offset, length int64, r io.Reader)
  • func (b *Builder) Build() error
• type EntryType
• type Reader
  • func Load(r io.ReaderAt) (*Reader, error)
  • func (r *Reader) Close() error
  • func (r *Reader) DataSize() int64
  • func (r *Reader) LiveSize() int64
  • func (r *Reader) LogLoadStats(logFn func(msg string, args ...any))
  • func (r *Reader) NextData(off int64) (int64, error)
  • func (r *Reader) NextHole(off int64) (int64, error)
  • func (r *Reader) ReadAt(p []byte, off int64) (int, error)
  • func (r *Reader) Size() int64

Constants

const (
	EntryType_Data EntryType = 0
	EntryType_Hole EntryType = 1

	MaxBlocks = (1 << 48)
	Magic     = "sparseblock\x31\x41\x59\x26\x53"
)

Variables

var (
	ErrEntryTooBig = errors.New("sparseblock/Builder: Entry too big")
	ErrShortRead   = errors.New("sparseblock/Builder: short read")
)

var (
	ErrInvalidMagic = errors.New("sparseblock/Reader: invalid magic")
	ErrInvalidIndex = errors.New("sparseblock/Reader: invalid index encoding")
)

Functions

func BuildFromReader

func BuildFromReader(dst io.Writer, src t.HoleReaderAt, blockSize int, opts *BuildOptions) error

Types

type BuildOptions

type BuildOptions struct {
	MaxDataSize int64
}

type Builder

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

func NewBuilder

func NewBuilder(w io.Writer, blockSize int) *Builder

func (*Builder) AddBlocks

func (b *Builder) AddBlocks(offset, length int64, r io.Reader)

func (*Builder) Build

func (b *Builder) Build() error

type EntryType

type EntryType int

type Reader

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

func Load

func Load(r io.ReaderAt) (*Reader, error)

func (*Reader) Close

func (r *Reader) Close() error

func (*Reader) DataSize

func (r *Reader) DataSize() int64

func (*Reader) LiveSize

func (r *Reader) LiveSize() int64

func (*Reader) LogLoadStats

func (r *Reader) LogLoadStats(logFn func(msg string, args ...any))

func (*Reader) NextData

func (r *Reader) NextData(off int64) (int64, error)

func (*Reader) NextHole

func (r *Reader) NextHole(off int64) (int64, error)

func (*Reader) ReadAt

func (r *Reader) ReadAt(p []byte, off int64) (int, error)

func (*Reader) Size

func (r *Reader) Size() int64