Documentation
¶
Index ¶
- Constants
- Variables
- func ForEachIterator(iter bareIterator, cb func(plumbing.EncodedObject) error) error
- func ResolveReference(s ReferenceStorer, n plumbing.ReferenceName) (*plumbing.Reference, error)
- type EncodedObjectIter
- type EncodedObjectLookupIter
- type EncodedObjectSliceIter
- type EncodedObjectStorer
- type IndexStorer
- type MultiEncodedObjectIter
- type PackfileWriter
- type ReferenceIter
- type ReferenceSliceIter
- type ReferenceStorer
- type ShallowStorer
- type Transaction
- type Transactioner
Constants ¶
const MaxResolveRecursion = 1024
Variables ¶
var ErrMaxResolveRecursion = errors.New("max. recursion level reached")
ErrMaxResolveRecursion is returned by ResolveReference is MaxResolveRecursion is exceeded
var ( //ErrStop is used to stop a ForEach function in an Iter ErrStop = errors.New("stop iter") )
Functions ¶
func ForEachIterator ¶
func ForEachIterator(iter bareIterator, cb func(plumbing.EncodedObject) error) error
ForEachIterator is a helper function to build iterators without need to rewrite the same ForEach function each time.
func ResolveReference ¶
func ResolveReference(s ReferenceStorer, n plumbing.ReferenceName) (*plumbing.Reference, error)
ResolveReference resolve a SymbolicReference to a HashReference
Types ¶
type EncodedObjectIter ¶
type EncodedObjectIter interface {
Next() (plumbing.EncodedObject, error)
ForEach(func(plumbing.EncodedObject) error) error
Close()
}
EncodedObjectIter is a generic closable interface for iterating over objects.
func NewMultiEncodedObjectIter ¶
func NewMultiEncodedObjectIter(iters []EncodedObjectIter) EncodedObjectIter
NewMultiEncodedObjectIter returns an object iterator for the given slice of objects.
type EncodedObjectLookupIter ¶
type EncodedObjectLookupIter struct {
// contains filtered or unexported fields
}
EncodedObjectLookupIter implements EncodedObjectIter. It iterates over a series of object hashes and yields their associated objects by retrieving each one from object storage. The retrievals are lazy and only occur when the iterator moves forward with a call to Next().
The EncodedObjectLookupIter must be closed with a call to Close() when it is no longer needed.
func NewEncodedObjectLookupIter ¶
func NewEncodedObjectLookupIter( storage EncodedObjectStorer, t plumbing.ObjectType, series []plumbing.Hash) *EncodedObjectLookupIter
NewEncodedObjectLookupIter returns an object iterator given an object storage and a slice of object hashes.
func (*EncodedObjectLookupIter) Close ¶
func (iter *EncodedObjectLookupIter) Close()
Close releases any resources used by the iterator.
func (*EncodedObjectLookupIter) ForEach ¶
func (iter *EncodedObjectLookupIter) ForEach(cb func(plumbing.EncodedObject) error) error
ForEach call the cb function for each object contained on this iter until an error happends or the end of the iter is reached. If ErrStop is sent the iteration is stop but no error is returned. The iterator is closed.
func (*EncodedObjectLookupIter) Next ¶
func (iter *EncodedObjectLookupIter) Next() (plumbing.EncodedObject, error)
Next returns the next object from the iterator. If the iterator has reached the end it will return io.EOF as an error. If the object can't be found in the object storage, it will return plumbing.ErrObjectNotFound as an error. If the object is retreieved successfully error will be nil.
type EncodedObjectSliceIter ¶
type EncodedObjectSliceIter struct {
// contains filtered or unexported fields
}
EncodedObjectSliceIter implements EncodedObjectIter. It iterates over a series of objects stored in a slice and yields each one in turn when Next() is called.
The EncodedObjectSliceIter must be closed with a call to Close() when it is no longer needed.
func NewEncodedObjectSliceIter ¶
func NewEncodedObjectSliceIter(series []plumbing.EncodedObject) *EncodedObjectSliceIter
NewEncodedObjectSliceIter returns an object iterator for the given slice of objects.
func (*EncodedObjectSliceIter) Close ¶
func (iter *EncodedObjectSliceIter) Close()
Close releases any resources used by the iterator.
func (*EncodedObjectSliceIter) ForEach ¶
func (iter *EncodedObjectSliceIter) ForEach(cb func(plumbing.EncodedObject) error) error
ForEach call the cb function for each object contained on this iter until an error happends or the end of the iter is reached. If ErrStop is sent the iteration is stop but no error is returned. The iterator is closed.
func (*EncodedObjectSliceIter) Next ¶
func (iter *EncodedObjectSliceIter) Next() (plumbing.EncodedObject, error)
Next returns the next object from the iterator. If the iterator has reached the end it will return io.EOF as an error. If the object is retreieved successfully error will be nil.
type EncodedObjectStorer ¶
type EncodedObjectStorer interface {
// NewEncodedObject returns a new plumbing.EncodedObject, the real type
// of the object can be a custom implementation or the default one,
// plumbing.MemoryObject.
NewEncodedObject() plumbing.EncodedObject
// SetEncodedObject saves an object into the storage, the object should
// be create with the NewEncodedObject, method, and file if the type is
// not supported.
SetEncodedObject(plumbing.EncodedObject) (plumbing.Hash, error)
// EncodedObject gets an object by hash with the given
// plumbing.ObjectType. Implementors should return
// (nil, plumbing.ErrObjectNotFound) if an object doesn't exist with
// both the given hash and object type.
//
// Valid plumbing.ObjectType values are CommitObject, BlobObject, TagObject,
// TreeObject and AnyObject. If plumbing.AnyObject is given, the object must
// be looked up regardless of its type.
EncodedObject(plumbing.ObjectType, plumbing.Hash) (plumbing.EncodedObject, error)
// IterObjects returns a custom EncodedObjectStorer over all the object
// on the storage.
//
// Valid plumbing.ObjectType values are CommitObject, BlobObject, TagObject,
IterEncodedObjects(plumbing.ObjectType) (EncodedObjectIter, error)
}
EncodedObjectStorer generic storage of objects
type IndexStorer ¶
IndexStorer generic storage of index.Index
type MultiEncodedObjectIter ¶
type MultiEncodedObjectIter struct {
// contains filtered or unexported fields
}
MultiEncodedObjectIter implements EncodedObjectIter. It iterates over several EncodedObjectIter,
The MultiObjectIter must be closed with a call to Close() when it is no longer needed.
func (*MultiEncodedObjectIter) Close ¶
func (iter *MultiEncodedObjectIter) Close()
Close releases any resources used by the iterator.
func (*MultiEncodedObjectIter) ForEach ¶
func (iter *MultiEncodedObjectIter) ForEach(cb func(plumbing.EncodedObject) error) error
ForEach call the cb function for each object contained on this iter until an error happends or the end of the iter is reached. If ErrStop is sent the iteration is stop but no error is returned. The iterator is closed.
func (*MultiEncodedObjectIter) Next ¶
func (iter *MultiEncodedObjectIter) Next() (plumbing.EncodedObject, error)
Next returns the next object from the iterator, if one iterator reach io.EOF is removed and the next one is used.
type PackfileWriter ¶
type PackfileWriter interface {
// PackfileWriter returns a writer for writing a packfile to the storage
//
// If the Storer not implements PackfileWriter the objects should be written
// using the Set method.
PackfileWriter() (io.WriteCloser, error)
}
PackfileWriter is a optional method for ObjectStorer, it enable direct write of packfile to the storage
type ReferenceIter ¶
type ReferenceIter interface {
Next() (*plumbing.Reference, error)
ForEach(func(*plumbing.Reference) error) error
Close()
}
ReferenceIter is a generic closable interface for iterating over references
type ReferenceSliceIter ¶
type ReferenceSliceIter struct {
// contains filtered or unexported fields
}
ReferenceSliceIter implements ReferenceIter. It iterates over a series of references stored in a slice and yields each one in turn when Next() is called.
The ReferenceSliceIter must be closed with a call to Close() when it is no longer needed.
func NewReferenceSliceIter ¶
func NewReferenceSliceIter(series []*plumbing.Reference) *ReferenceSliceIter
NewReferenceSliceIter returns a reference iterator for the given slice of objects.
func (*ReferenceSliceIter) Close ¶
func (iter *ReferenceSliceIter) Close()
Close releases any resources used by the iterator.
func (*ReferenceSliceIter) ForEach ¶
func (iter *ReferenceSliceIter) ForEach(cb func(*plumbing.Reference) error) error
ForEach call the cb function for each reference contained on this iter until an error happends or the end of the iter is reached. If ErrStop is sent the iteration is stop but no error is returned. The iterator is closed.
type ReferenceStorer ¶
type ReferenceStorer interface {
SetReference(*plumbing.Reference) error
Reference(plumbing.ReferenceName) (*plumbing.Reference, error)
IterReferences() (ReferenceIter, error)
}
ReferenceStorer generic storage of references
type ShallowStorer ¶
type ShallowStorer interface {
SetShallow([]plumbing.Hash) error
Shallow() ([]plumbing.Hash, error)
}
ShallowStorer storage of references to shallow commits by hash, meaning that these commits have missing parents because of a shallow fetch.
type Transaction ¶
type Transaction interface {
SetEncodedObject(plumbing.EncodedObject) (plumbing.Hash, error)
EncodedObject(plumbing.ObjectType, plumbing.Hash) (plumbing.EncodedObject, error)
Commit() error
Rollback() error
}
Transaction is an in-progress storage transaction. A transaction must end with a call to Commit or Rollback.
type Transactioner ¶
type Transactioner interface {
// Begin starts a transaction.
Begin() Transaction
}
Transactioner is a optional method for ObjectStorer, it enable transaction base write and read operations in the storage
Source Files