fs.go

package fs

import (
	"io/fs"
	"net/http"
)

// FlexibleFS represents a flexible file system that provides
// various methods for embed and local file operations.
type FlexibleFS interface {
	// Exists checks if a file with the given name exists in the file system.
	// It returns a boolean indicating existence and an error if any occurs.
	Exists(path string) (bool, error)

	// Open opens a file with the given name and returns an fs.File interface
	// for reading the file. It returns an error if the file cannot be opened.
	Open(path string) (fs.File, error)

	// ReadFile reads the entire content of the file with the given name and
	// returns the content as a byte slice. It returns an error if the file
	// cannot be read.
	ReadFile(path string) ([]byte, error)

	// Search searches for a phrase in files within the specified directory,
	// optionally ignoring certain files and filtering by extension.
	Search(dir, phrase, ignore, ext string) (*string, error)

	// Find searches for a file matching the given pattern in the specified
	// path. It returns the path of the found file and an error if any occurs.
	Find(dir, pattern string) (*string, error)

	// Lookup searches for files matching the given pattern in the specified
	// path. It returns a slice of paths of the found files and an error if any occurs.
	Lookup(dir, pattern string) ([]string, error)

	// PathOf joins the provided path parts into a single normalized path,
	// applying the file system's prefix if applicable. It ensures the resulting
	// path is consistent with the file system's internal structure and prefixing rules.
	PathOf(parts ...string) string

	// Prefix returns the path prefix for embedded file system.
	Prefix() string

	// IsEmbedded returns true if the file system is an embedded file system.
	IsEmbedded() bool

	// FS returns the underlying fs.FS interface of the file system.
	FS() fs.FS

	// Http returns the http.FileSystem instance of the file system.
	Http() http.FileSystem
}