internal

Documentation

Overview

Package internal provides some helpers used by packing implementations.

Index

• func BlockSum(bs []upspin.DirBlock) []byte
• func CheckLocationSet(d *upspin.DirEntry) error
• type BlockTracker
  • func NewBlockTracker(bs []upspin.DirBlock) BlockTracker
  • func (t *BlockTracker) NextBlock() (upspin.DirBlock, bool)
  • func (t *BlockTracker) SeekBlock(n int) (upspin.DirBlock, bool)
• type LazyBuffer
  • func (b *LazyBuffer) Bytes(n int) []byte

Functions

func BlockSum

func BlockSum(bs []upspin.DirBlock) []byte

BlockSum returns the SHA256 hash of the given DirBlocks' Packdata.

func CheckLocationSet

func CheckLocationSet(d *upspin.DirEntry) error

CheckLocationSet checks whether the previous block's Location field was set, to prevent misuse of the BlockPacker API.

Types

type BlockTracker

type BlockTracker struct {
	// Block is the index of the current block.
	Block int
	// contains filtered or unexported fields
}

BlockTracker maintains an index into a slice of upspin.DirBlock.

func NewBlockTracker

func NewBlockTracker(bs []upspin.DirBlock) BlockTracker

NewBlockTracker returns a BlockTracker that iterates over the given slice.

func (*BlockTracker) NextBlock

func (t *BlockTracker) NextBlock() (upspin.DirBlock, bool)

NextBlock implements part of the upspin.BlockUnpacker interface.

func (*BlockTracker) SeekBlock

func (t *BlockTracker) SeekBlock(n int) (upspin.DirBlock, bool)

SeekBlock implements part of the upspin.BlockUnpacker interface.

type LazyBuffer

type LazyBuffer []byte

LazyBuffer is a []byte that is lazily (re-)allocated when its Bytes method is called.

func (*LazyBuffer) Bytes

func (b *LazyBuffer) Bytes(n int) []byte

Bytes returns a []byte that has length n. It re-uses the underlying LazyBuffer []byte if it is at least n bytes in length.