README
¶
gitreader
There are times, in a developers life, when they need to read data out of a git repository.
In those times, there are 3 paths to take:
- Shell out to the git subcommands to pull the data out
- Use an API that just shells out to git subcommands
- Use an API that implements parts of git itself
For various reasons, there are times where #1 and #2 are clunky and unacceptable. For those times, we have APIs that implement parts of git. This is one of those APIs.
This specific API implements a golang library that contains only the functionality to read a git repository on disk. No remote protocols, no ability to write new data, only reading.
So when you're in golang and need to read some data out a git repository, reach for gitreader, you'll be happy with yourself.
- Vektra Devs
Usage
import "fmt"
import "gitreader"
repo, err := gitreader.OpenRepo("/path/to/repo")
if err != nil {
panic(err)
}
blob, err := repo.CatFile("HEAD", "path/to/file")
if err != nil {
panic(err)
}
// WARNING: use Blob as an io.Reader instead if you can!
bytes, err := blob.Bytes()
if err != nil {
panic(err)
}
fmt.Printf("%s", bytes)
repo.Close()
Documentation
¶
Overview ¶
Implements enough of the git format to read data out of an on-disk git repo.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrBadDelta = errors.New("bad delta")
var ErrBadIndex = errors.New("bad index format")
var ErrBadPack = errors.New("bad pack format")
var ErrInvalidRepo = errors.New("invalid repo")
var ErrNotBlob = errors.New("object is not a blob")
var ErrNotCommit = errors.New("ref is not a commit")
var ErrNotExist = errors.New("object does not exist")
var ErrNotFound = errors.New("object not found")
var ErrNotTree = errors.New("object is not a tree")
var ErrUnknownRef = errors.New("unknown ref")
var ErrUnknownType = errors.New("unknown type")
Functions ¶
This section is empty.
Types ¶
type LooseObject ¶
type LooseObject struct {
Base string
}
Implements reading objects out of the .git/objects directory
func (*LooseObject) Close ¶
func (l *LooseObject) Close() error
func (*LooseObject) LoadObject ¶
func (l *LooseObject) LoadObject(id string) (*Object, error)
type Object ¶
func ParseObject ¶
Read the data and construct a new Object
type Pack ¶
type Pack struct {
// contains filtered or unexported fields
}
Implements LoadObject for a pack file
type Repo ¶
func OpenRepo ¶
Open up a repository. Can be either normal or bare. Be sure to issue Close() on a repo when you're finished with it because that makes sure that any pack files used by the repo are properly unmapped.
Source Files