Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

v2

package

Go to main page

Versions in this module

v5

v5.0.0

Feb 25, 2024

Changes in this version

+ var ErrMalformedCommitGraphFile = errors.New("malformed commit graph file")

+ var ErrUnsupportedHash = errors.New("unsupported hash algorithm")

+ var ErrUnsupportedVersion = errors.New("unsupported version")

+ func OpenChainFile(r io.Reader) ([]string, error)

+ type ChunkType int

+ const BaseGraphsListChunk

+ const BloomFilterDataChunk

+ const BloomFilterIndexChunk

+ const CommitDataChunk

+ const ExtraEdgeListChunk

+ const GenerationDataChunk

+ const GenerationDataOverflowChunk

+ const OIDFanoutChunk

+ const OIDLookupChunk

+ const ZeroChunk

+ func ChunkTypeFromBytes(b []byte) (ChunkType, bool)

+ func (ct ChunkType) Signature() []byte

+ type CommitData struct

+ Generation uint64

+ GenerationV2 uint64

+ ParentHashes []plumbing.Hash

+ ParentIndexes []uint32

+ TreeHash plumbing.Hash

+ When time.Time

+ func (c *CommitData) GenerationV2Data() uint64

+ type Encoder struct

+ func NewEncoder(w io.Writer) *Encoder

+ func (e *Encoder) Encode(idx Index) error

+ type Index interface

+ GetCommitDataByIndex func(i uint32) (*CommitData, error)

+ GetHashByIndex func(i uint32) (plumbing.Hash, error)

+ GetIndexByHash func(h plumbing.Hash) (uint32, error)

+ HasGenerationV2 func() bool

+ Hashes func() []plumbing.Hash

+ MaximumNumberOfHashes func() uint32

+ func OpenChainIndex(fs billy.Filesystem) (Index, error)

+ func OpenChainOrFileIndex(fs billy.Filesystem) (Index, error)

+ func OpenFileIndex(reader ReaderAtCloser) (Index, error)

+ func OpenFileIndexWithParent(reader ReaderAtCloser, parent Index) (Index, error)

+ type MemoryIndex struct

+ func NewMemoryIndex() *MemoryIndex

+ func (mi *MemoryIndex) Add(hash plumbing.Hash, data *CommitData)

+ func (mi *MemoryIndex) Close() error

+ func (mi *MemoryIndex) GetCommitDataByIndex(i uint32) (*CommitData, error)

+ func (mi *MemoryIndex) GetHashByIndex(i uint32) (plumbing.Hash, error)

+ func (mi *MemoryIndex) GetIndexByHash(h plumbing.Hash) (uint32, error)

+ func (mi *MemoryIndex) HasGenerationV2() bool

+ func (mi *MemoryIndex) Hashes() []plumbing.Hash

+ func (mi *MemoryIndex) MaximumNumberOfHashes() uint32

+ type ReaderAtCloser interface