scope

type ContentResolver interface {
	FileContentsByRef(ref file.Reference) (string, error)
	MultipleFileContentsByRef(f ...file.Reference) (map[file.Reference]string, error)
}

type DirSource struct {
	Path string // the root path to be cataloged
}

type FileResolver interface {
	// FilesByPath fetches a set of file references which have the given path (for an image, there may be multiple matches)
	FilesByPath(paths ...file.Path) ([]file.Reference, error)
	// FilesByGlob fetches a set of file references which the given glob matches
	FilesByGlob(patterns ...string) ([]file.Reference, error)
	// RelativeFileByPath fetches a single file at the given path relative to the layer squash of the given reference.
	// This is helpful when attempting to find a file that is in the same layer or lower as another file.
	RelativeFileByPath(reference file.Reference, path string) (*file.Reference, error)
}

type ImageSource struct {
	Img *image.Image // the image object to be cataloged
}

type Option int

type Resolver interface {
	ContentResolver
	FileResolver
}

type Scheme string

type Scope struct {
	Option   Option      // specific perspective to catalog
	Resolver Resolver    // a Resolver object to use in file path/glob resolution and file contents resolution
	Source   interface{} // the specific source object to be cataloged
	Scheme   Scheme      // the source data scheme type (directory or image)
}