storer

package
Version: v5.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 14, 2020 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package storer defines the interfaces to store objects, references, etc.

Index

Constants

View Source
const MaxResolveRecursion = 1024

Variables

View Source
var ErrMaxResolveRecursion = errors.New("max. recursion level reached")

ErrMaxResolveRecursion is returned by ResolveReference is MaxResolveRecursion is exceeded

View Source
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 resolves a SymbolicReference to a HashReference.

Types

type DeltaObjectStorer

type DeltaObjectStorer interface {
	// DeltaObject is the same as EncodedObject but without resolving deltas.
	// Deltas will be returned as plumbing.DeltaObject instances.
	DeltaObject(plumbing.ObjectType, plumbing.Hash) (plumbing.EncodedObject, error)
}

DeltaObjectStorer is an EncodedObjectStorer that can return delta objects.

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 EncodedObjectIters.

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 happens 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

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 retrieved 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 happens 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

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 retrieved 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)
	// HasEncodedObject returns ErrObjNotFound if the object doesn't
	// exist.  If the object does exist, it returns nil.
	HasEncodedObject(plumbing.Hash) error
	// EncodedObjectSize returns the plaintext size of the encoded object.
	EncodedObjectSize(plumbing.Hash) (int64, error)
}

EncodedObjectStorer generic storage of objects

type IndexStorer

type IndexStorer interface {
	SetIndex(*index.Index) error
	Index() (*index.Index, error)
}

IndexStorer generic storage of index.Index

type Initializer

type Initializer interface {
	// Init performs initialization of the storer and returns the error, if
	// any.
	Init() error
}

Initializer should be implemented by storers that require to perform any operation when creating a new repository (i.e. git init).

type LooseObjectStorer

type LooseObjectStorer interface {
	// ForEachObjectHash iterates over all the (loose) object hashes
	// in the repository without necessarily having to read those objects.
	// Objects only inside pack files may be omitted.
	// If ErrStop is sent the iteration is stop but no error is returned.
	ForEachObjectHash(func(plumbing.Hash) error) error
	// LooseObjectTime looks up the (m)time associated with the
	// loose object (that is not in a pack file). Some
	// implementations (e.g. without loose objects)
	// always return an error.
	LooseObjectTime(plumbing.Hash) (time.Time, error)
	// DeleteLooseObject deletes a loose object if it exists.
	DeleteLooseObject(plumbing.Hash) error
}

LooseObjectStorer is an optional interface for managing "loose" objects, i.e. those not in packfiles.

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 happens 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

Next returns the next object from the iterator, if one iterator reach io.EOF is removed and the next one is used.

type MultiReferenceIter

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

MultiReferenceIter implements ReferenceIter. It iterates over several ReferenceIter,

The MultiReferenceIter must be closed with a call to Close() when it is no longer needed.

func (*MultiReferenceIter) Close

func (iter *MultiReferenceIter) Close()

Close releases any resources used by the iterator.

func (*MultiReferenceIter) ForEach

func (iter *MultiReferenceIter) ForEach(cb func(*plumbing.Reference) error) error

ForEach call the cb function for each reference contained on this iter until an error happens 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 (*MultiReferenceIter) Next

func (iter *MultiReferenceIter) Next() (*plumbing.Reference, error)

Next returns the next reference from the iterator, if one iterator reach io.EOF is removed and the next one is used.

type PackedObjectStorer

type PackedObjectStorer interface {
	// ObjectPacks returns hashes of object packs if the underlying
	// implementation has pack files.
	ObjectPacks() ([]plumbing.Hash, error)
	// DeleteOldObjectPackAndIndex deletes an object pack and the corresponding index file if they exist.
	// Deletion is only performed if the pack is older than the supplied time (or the time is zero).
	DeleteOldObjectPackAndIndex(plumbing.Hash, time.Time) error
}

PackedObjectStorer is an optional interface for managing objects in packfiles.

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.

func NewMultiReferenceIter

func NewMultiReferenceIter(iters []ReferenceIter) ReferenceIter

NewMultiReferenceIter returns an reference iterator for the given slice of EncodedObjectIters.

func NewReferenceFilteredIter

func NewReferenceFilteredIter(
	ff func(r *plumbing.Reference) bool, iter ReferenceIter) ReferenceIter

NewReferenceFilteredIter returns a reference iterator for the given reference Iterator. This iterator will iterate only references that accomplish the provided function.

func NewReferenceSliceIter

func NewReferenceSliceIter(series []*plumbing.Reference) ReferenceIter

NewReferenceSliceIter returns a reference iterator for the given slice of objects.

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 (*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 happens 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 (*ReferenceSliceIter) Next

func (iter *ReferenceSliceIter) Next() (*plumbing.Reference, error)

Next returns the next reference from the iterator. If the iterator has reached the end it will return io.EOF as an error.

type ReferenceStorer

type ReferenceStorer interface {
	SetReference(*plumbing.Reference) error
	// CheckAndSetReference sets the reference `new`, but if `old` is
	// not `nil`, it first checks that the current stored value for
	// `old.Name()` matches the given reference value in `old`.  If
	// not, it returns an error and doesn't update `new`.
	CheckAndSetReference(new, old *plumbing.Reference) error
	Reference(plumbing.ReferenceName) (*plumbing.Reference, error)
	IterReferences() (ReferenceIter, error)
	RemoveReference(plumbing.ReferenceName) error
	CountLooseRefs() (int, error)
	PackRefs() error
}

ReferenceStorer is a generic storage of references.

type ShallowStorer

type ShallowStorer interface {
	SetShallow([]plumbing.Hash) error
	Shallow() ([]plumbing.Hash, error)
}

ShallowStorer is a storage of references to shallow commits by hash, meaning that these commits have missing parents because of a shallow fetch.

type Storer

type Storer interface {
	EncodedObjectStorer
	ReferenceStorer
}

Storer is a basic storer for encoded objects and references.

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL