repo

type Capability uint

type ErrDuplicateID struct {
	// ID is the offending ID.
	ID string
	// Repo is the repository name.
	Repo string
}

type ErrDuplicatePath struct {
	// Path is the offending path.
	Path string
	// Repo is the repository name.
	Repo string
}

type ErrInvalidID struct {
	// ID is the offending id.
	ID string
	// Expected is the expected name form, a regular expression or a simple description.
	Expected string
}

type ErrInvalidMediaPath struct {
	// Path is the offending path.
	Path string
	// Root is the root directory of the repository.
	Root string
}

type ErrInvalidMediaType struct {
	// Path is the offending media path.
	Path string
	// Type is the offending MIME type.
	Type string
}

type ErrUnsupportedFormat struct {
	// Format is the offending format name.
	Format string
	// Operation is the unsupported operation.
	Operation string
}

type ErrUnsupportedOperation struct {
	// Operation is the unsupported operation.
	Operation string
	// Repo is the repository name.
	Repo string
}

type MutableRepository interface {
	Repository

	// Scan tries to recursively discover missing media from the repository root directory.
	Scan() error
	// Add adds media to the repository.
	Add(m media.Media) error
	// AddPath adds media at the supplied path to the repository.
	AddPath(path string) error
	// Remove removes media from the repository.
	Remove(m media.Media) error
	// RemovePath removes media with the supplied absolute path from the repository.
	RemovePath(path string) error
}

type Repository interface {
	// ID returns the repository ID, alphanumeric, lowercase, non-blank ([a-z0-9-_]).
	ID() string
	// Name returns the repository name.
	Name() string
	// Path returns the path to the root directory of this repository, absolute.
	Path() string
	// Capabilities returns the capabilities of this repository.
	Capabilities() Capability

	// Get tries to get media by its ID in this repository, returns nil if not found.
	Get(id string) media.Media
	// Find tries to find media of an absolute or relative path in this repository, returns nil if not found.
	Find(path string) media.Media
	// Items returns the pieces of media in this repository.
	Items() []media.Media

	// Remux remuxes media to the desired container format and returns the remuxed media or nil, if the ID wasn't found.
	// ErrUnsupportedOperation may be returned if the repository does not have the CapabilityRemux capability.
	Remux(id string, format *media.Format) (media.Media, error)

	// Source returns the metadata source for this repository.
	Source() meta.Source

	// Close cleans up residual data after the repository.
	// The repository should not be used any further after calling Close.
	Close() error

	// Mutable tries to assert this repository view to a MutableRepository, returns nil if not possible.
	Mutable() MutableRepository
}