packfile

Documentation

Index

• Variables
• type Format
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (r *Reader) Read(s core.ObjectStorage) (int64, error)
• type ReaderError
  • func (e *ReaderError) Error() string

Variables

var (
	EmptyRepositoryErr        = newError("empty repository")
	UnsupportedVersionErr     = newError("unsupported packfile version")
	MaxObjectsLimitReachedErr = newError("max. objects limit reached")
	MalformedPackfileErr      = newError("malformed pack file, does not start with 'PACK'")
	InvalidObjectErr          = newError("invalid git object")
	PatchingErr               = newError("patching error")
	PackEntryNotFoundErr      = newError("can't find a pack entry")
	ObjectNotFoundErr         = newError("can't find a object")
	ZLibErr                   = newError("zlib reading error")
)

Types

type Format

type Format int

const (
	DefaultMaxObjectsLimit = 1 << 20

	VersionSupported        = 2
	UnknownFormat    Format = 0
	OFSDeltaFormat   Format = 1
	REFDeltaFormat   Format = 2
)

type Reader

type Reader struct {
	// MaxObjectsLimit is the limit of objects to be load in the packfile, if
	// a packfile excess this number an error is throw, the default value
	// is defined by DefaultMaxObjectsLimit, usually the default limit is more
	// than enough to work with any repository, working extremly big repositories
	// where the number of object is bigger the memory can be exhausted.
	MaxObjectsLimit uint32

	// Format specifies if we are using ref-delta's or ofs-delta's, choosing the
	// correct format the memory usage is optimized
	// https://github.com/git/git/blob/8d530c4d64ffcc853889f7b385f554d53db375ed/Documentation/technical/protocol-capabilities.txt#L154
	Format Format
	// contains filtered or unexported fields
}

Reader reads a packfile from a binary string splitting it on objects

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns a new Reader that reads from a io.Reader

func (*Reader) Read

func (r *Reader) Read(s core.ObjectStorage) (int64, error)

Read reads the objects and stores it at the ObjectStorage

type ReaderError

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

func (*ReaderError) Error

func (e *ReaderError) Error() string