shithub: furgit

ref: e7ce17381f525328073577d60583447fc9412c18
dir: /refstore/reading.go/

package refstore

import "codeberg.org/lindenii/furgit/ref"

// ReadingStore reads Git references.
type ReadingStore interface {
	// Resolve resolves a reference name to either a symbolic or detached ref.
	//
	// Implementations should return value forms (ref.Detached or ref.Symbolic),
	// not pointer forms. Returned refs do not borrow the store.
	// If the reference does not exist, implementations should return
	// ErrReferenceNotFound.
	Resolve(name string) (ref.Ref, error)
	// ResolveToDetached resolves a reference name to a detached object ID.
	//
	// Implementations may use backend-local lookup semantics for symbolic hops.
	// Callers that need cross-backend symbolic resolution (for example in a
	// chain of stores) should prefer repeatedly calling Resolve.
	//
	// ResolveToDetached resolves symbolic references only. It does not imply peeling
	// annotated tag objects.
	ResolveToDetached(name string) (ref.Detached, error)
	// List returns references matching pattern.
	//
	// The exact pattern language is backend-defined.
	List(pattern string) ([]ref.Ref, error)
	// Close releases resources associated with the store.
	//
	// Transactions and batches borrowing the store are invalid after Close.
	//
	// Repeated calls to Close are undefined behavior unless the implementation
	// explicitly documents otherwise.
	Close() error
}