filesystem

type AbsPathFileSystem ¶

type AbsPathFileSystem struct {
	CurrentDir string
	Backend    FileSystem
}

AbsPathFileSystem completes absolute path for every file access. The absolute path is made by using filepath.Abs when CurrentDir is set to empty, or made by file.Join(CurrentDir, relativePath) when CurrentDir is set. The Backend is used to access File API. and The OSFileSystem is used as Backend when it is nil.

func (absfs *AbsPathFileSystem) Exist(fpath string) bool

func (absfs *AbsPathFileSystem) Load(fpath string) (reader io.ReadCloser, err error)

func (absfs *AbsPathFileSystem) ResolvePath(fpath string) (string, error)

func (absfs *AbsPathFileSystem) Store(fpath string) (writer io.WriteCloser, err error)

type FileSystem ¶

type FileSystem interface {
	Loader

	// create data store entry.
	Store(filepath string) (io.WriteCloser, error)
}

abstraction for the filesystem.

type FileSystemPR ¶ added in v0.7.0

type FileSystemPR interface {
	FileSystem
	PathResolver
}

FileSystemPR is a composit interface with FileSystem and PathResolver interfaces.

var (
	// Default is a default FileSystem to be used by exported functions.
	Default FileSystemPR = Desktop
)

type Loader ¶

type Loader interface {
	// Load loads content specified by the relative path
	// from erago system root directory.
	// It returns io.Reader for the loaded content with no error,
	// or returns nil with file loading error.
	Load(filepath string) (reader io.ReadCloser, err error)

	// Exist checks whether given filepath exist from erago system root directory.
	// It returns true when the filepath exists, otherwise return false.
	Exist(filepath string) bool
}

Loader is a platform depended file loader which searches file path and return its content as io.Reader.

var (
	// Desktop is a FileSystem for the desktop environment
	Desktop = &OSFileSystem{MaxFileSize: DefaultMaxFileSize}
	// String is a adaptation of strings.Buffer with Loader interface.
	String Loader = LoaderFunc(StringReadCloser)
)

type LoaderFunc ¶

type LoaderFunc func(string) (io.ReadCloser, error)

LoaderFunc implements Loader interface.

func (fn LoaderFunc) Exist(filepath string) bool

func (fn LoaderFunc) Load(filepath string) (reader io.ReadCloser, err error)

type NopPathResolver ¶ added in v0.7.0

type NopPathResolver struct{}

NopPathResolver implements PathResolver interface.

func (NopPathResolver) ResolvePath(path string) (string, error)

type OSFileSystem ¶

type OSFileSystem struct {
	MaxFileSize int64 // in bytes
}

OSFileSystem is a adaptation of the os.Open() with Loader interface.

func (osfs *OSFileSystem) Exist(filepath string) bool

func (osfs *OSFileSystem) Load(filepath string) (reader io.ReadCloser, err error)

func (osfs *OSFileSystem) ResolvePath(fpath string) (string, error)

func (osfs *OSFileSystem) Store(fpath string) (writer io.WriteCloser, err error)

type PathResolver ¶

type PathResolver interface {
	ResolvePath(path string) (string, error)
}

path resolver resolves file path on the filesystem.

type RFileSystemPR ¶ added in v0.7.0

type RFileSystemPR interface {
	Loader
	PathResolver
}

RFileSystemPR is a Readonly FileSystemPR interface.

type WatchEvent ¶ added in v0.7.0

type WatchEvent = fsnotify.Event

Export some types and values so that user need not import underlying package explicitly

type WatchOp ¶ added in v0.7.0

type WatchOp = fsnotify.Op

type Watcher ¶ added in v0.7.0

type Watcher interface {
	Watch(filepath string) error
	UnWatch(filepath string) error
	Events() <-chan WatchEvent
	Errors() <-chan error
	Close() error
}

func OpenWatcher() (Watcher, error)

func OpenWatcherPR(pr PathResolver) (Watcher, error)