borges

type Library interface {
	// ID returns the LibraryID for this Library.
	ID() LibraryID
	// Init initializes a new Repository in a Location, the chosen Location
	// is dependant on the implementation, if this this not supported should
	// return ErrNotImplemented. If a repository with the given RepositoryID
	// already exists ErrRepositoryExists is returned.
	Init(RepositoryID) (Repository, error)
	// Get open a repository with the given RepositoryID, it itereates all the
	// library locations until this repository is found. If a repository with
	// the given RepositoryID can't be found the ErrRepositoryNotExists is
	// returned.
	Get(RepositoryID, Mode) (Repository, error)
	// GetOrInit open or initilizes a Repository at a Location, if this this not
	// supported should return ErrNotImplemented. If the repository is opened
	// this will be done in RWMode.
	GetOrInit(RepositoryID) (Repository, error)
	// Has returns true, the LibraryID and the LocationID if the given
	// RepositoryID matches any repository at any location belonging to this
	// Library.
	Has(RepositoryID) (bool, LibraryID, LocationID, error)
	// Repositories returns a RepositoryIterator that iterates through all
	// the repositories contained in all Location contained in this Library.
	Repositories(Mode) (RepositoryIterator, error)
	// Location returns the Location with the given LocationID, if a location
	// can't be found ErrLocationNotExists is returned.
	Location(LocationID) (Location, error)
	// Locations returns a LocationIterator that iterates through all locations
	// contained in this Library.
	Locations() (LocationIterator, error)
}

type LibraryID string

type LibraryIterator interface {
	// Next returns the next library from the iterator. If the iterator has
	// reached the end it will return io.EOF as an error.
	Next() (Library, error)
	// ForEach call the 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.
	//
	// util.ForEachLibraryIterator should be used to implement this function
	// unless that performance reason exists.
	ForEach(func(Library) error) error
	// Close releases any resources used by the iterator.
	Close()
}

type Location interface {
	// ID returns the LocationID for this Location.
	ID() LocationID
	// Library returns the the Library the Location belongs to if any.
	Library() Library
	// Init initializes a new Repository at this Location.
	Init(RepositoryID) (Repository, error)
	// Get open a repository with the given RepositoryID, this operation doesn't
	// perform any read operation. If a repository with the given RepositoryID
	// already exists ErrRepositoryExists is returned.
	Get(RepositoryID, Mode) (Repository, error)
	// GetOrInit open or initilizes a Repository at this Location. If a
	// repository with the given RepositoryID can't be found the
	// ErrRepositoryNotExists is returned. If the repository is opened this will
	// be done in RWMode.
	GetOrInit(RepositoryID) (Repository, error)
	// Has returns true if the given RepositoryID matches any repository at
	// this location.
	Has(RepositoryID) (bool, error)
	// Repositories returns a RepositoryIterator that iterates through all
	// the repositories contained in this Location.
	Repositories(Mode) (RepositoryIterator, error)
}

type LocationID string

type LocationIterator interface {
	// Next returns the next location from the iterator. If the iterator has
	// reached the end it will return io.EOF as an error.
	Next() (Location, error)
	// ForEach call the 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.
	//
	// util.ForEachLocatorIterator should be used to implement this function
	// unless that performance reason exists.
	ForEach(func(Location) error) error
	// Close releases any resources used by the iterator.
	Close()
}

type Mode int

type Repository interface {
	// ID returns the RepositoryID.
	ID() RepositoryID
	// Location returns the the Library the Location belongs to.
	Location() Location
	// Mode returns the Mode how it was opened.
	Mode() Mode
	// Commit persists all the write operations done since was open, if the
	// repository doesn't provide Transactional capabilities should return
	// ErrNonTransactional.
	Commit() error
	// Close closes the repository, if the repository was opened in transactional
	// Mode, will delete any write operation pending to be written.
	Close() error
	// R returns the git.Repository.
	R() *git.Repository
	// FS returns the filesystem to read or write directly to the repository or
	// nil if not available.
	FS() billy.Filesystem
}

type RepositoryID string

type RepositoryIterator interface {
	// Next returns the next repository from the iterator. If the iterator has
	// reached the end it will return io.EOF as an error.
	Next() (Repository, error)
	// ForEach call the 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.
	//
	// util.ForEachRepositoryIterator should be used to implement this function
	// unless that performance reason exists.
	ForEach(func(Repository) error) error
	// Close releases any resources used by the iterator.
	Close()
}