import "github.com/go-git/go-git/storage/filesystem"
Package filesystem is a storage backend base on filesystems
config.go deltaobject.go index.go module.go object.go reference.go shallow.go storage.go
func NewPackfileIter(
fs billy.Filesystem,
f billy.File,
idxFile billy.File,
t plumbing.ObjectType,
keepPack bool,
) (storer.EncodedObjectIter, error)NewPackfileIter returns a new EncodedObjectIter for the provided packfile and object type. Packfile and index file will be closed after they're used. If keepPack is true the packfile won't be closed after the iteration finished.
type ConfigStorage struct {
// contains filtered or unexported fields
}func (c *ConfigStorage) Config() (conf *config.Config, err error)
func (c *ConfigStorage) SetConfig(cfg *config.Config) (err error)
type IndexStorage struct {
// contains filtered or unexported fields
}func (s *IndexStorage) Index() (i *index.Index, err error)
func (s *IndexStorage) SetIndex(idx *index.Index) (err error)
type ModuleStorage struct {
// contains filtered or unexported fields
}type ObjectStorage struct {
// contains filtered or unexported fields
}NewObjectStorage creates a new ObjectStorage with the given .git directory and cache.
func NewObjectStorageWithOptions(dir *dotgit.DotGit, objectCache cache.Object, ops Options) *ObjectStorage
NewObjectStorageWithOptions creates a new ObjectStorage with the given .git directory, cache and extra options
func (s *ObjectStorage) Close() error
Close closes all opened files.
func (s *ObjectStorage) DeleteLooseObject(hash plumbing.Hash) error
func (s *ObjectStorage) DeltaObject(t plumbing.ObjectType, h plumbing.Hash) (plumbing.EncodedObject, error)
DeltaObject returns the object with the given hash, by searching for it in the packfile and the git object directories.
func (s *ObjectStorage) EncodedObject(t plumbing.ObjectType, h plumbing.Hash) (plumbing.EncodedObject, error)
EncodedObject returns the object with the given hash, by searching for it in the packfile and the git object directories.
EncodedObjectSize returns the plaintext size of the given object, without actually reading the full object data from storage.
func (s *ObjectStorage) HasEncodedObject(h plumbing.Hash) (err error)
HasEncodedObject returns nil if the object exists, without actually reading the object data from storage.
func (s *ObjectStorage) IterEncodedObjects(t plumbing.ObjectType) (storer.EncodedObjectIter, error)
IterEncodedObjects returns an iterator for all the objects in the packfile with the given type.
func (s *ObjectStorage) NewEncodedObject() plumbing.EncodedObject
func (s *ObjectStorage) ObjectPacks() ([]plumbing.Hash, error)
func (s *ObjectStorage) PackfileWriter() (io.WriteCloser, error)
func (s *ObjectStorage) Reindex()
Reindex indexes again all packfiles. Useful if git changed packfiles externally
func (s *ObjectStorage) SetEncodedObject(o plumbing.EncodedObject) (h plumbing.Hash, err error)
SetEncodedObject adds a new object to the storage.
type Options struct {
// ExclusiveAccess means that the filesystem is not modified externally
// while the repo is open.
ExclusiveAccess bool
// KeepDescriptors makes the file descriptors to be reused but they will
// need to be manually closed calling Close().
KeepDescriptors bool
// MaxOpenDescriptors is the max number of file descriptors to keep
// open. If KeepDescriptors is true, all file descriptors will remain open.
MaxOpenDescriptors int
}Options holds configuration for the storage.
type ReferenceStorage struct {
// contains filtered or unexported fields
}func (r *ReferenceStorage) CheckAndSetReference(ref, old *plumbing.Reference) error
func (r *ReferenceStorage) CountLooseRefs() (int, error)
func (r *ReferenceStorage) IterReferences() (storer.ReferenceIter, error)
func (r *ReferenceStorage) PackRefs() error
func (r *ReferenceStorage) Reference(n plumbing.ReferenceName) (*plumbing.Reference, error)
func (r *ReferenceStorage) RemoveReference(n plumbing.ReferenceName) error
func (r *ReferenceStorage) SetReference(ref *plumbing.Reference) error
type ShallowStorage struct {
// contains filtered or unexported fields
}ShallowStorage where the shallow commits are stored, an internal to manipulate the shallow file
func (s *ShallowStorage) SetShallow(commits []plumbing.Hash) error
SetShallow save the shallows in the shallow file in the .git folder as one commit per line represented by 40-byte hexadecimal object terminated by a newline.
func (s *ShallowStorage) Shallow() ([]plumbing.Hash, error)
Shallow return the shallow commits reading from shallo file from .git
type Storage struct {
ObjectStorage
ReferenceStorage
IndexStorage
ShallowStorage
ConfigStorage
ModuleStorage
// contains filtered or unexported fields
}Storage is an implementation of git.Storer that stores data on disk in the standard git format (this is, the .git directory). Zero values of this type are not safe to use, see the NewStorage function below.
NewStorage returns a new Storage backed by a given `fs.Filesystem` and cache.
NewStorageWithOptions returns a new Storage with extra options, backed by a given `fs.Filesystem` and cache.
Filesystem returns the underlying filesystem
Init initializes .git directory
| Path | Synopsis |
|---|---|
| dotgit | https://github.com/git/git/blob/master/Documentation/gitrepository-layout.txt |
Package filesystem imports 18 packages (graph). Updated 2020-07-22. Refresh now. Tools for package owners.