fsys

type Config struct {
	// contains filtered or unexported fields
}

type File interface {
	io.Reader
	io.Writer
	io.Closer

	// Name returns the name of the file
	Name() string

	// Size returns the size of the file
	Size() int64

	// Sync attempts to sync the file with the underlying storage or errors if it
	// can't not succeed.
	Sync() error
}

type FileSystem interface {
	// Create takes a path, creates the file and then returns a File back that
	// can be used. This returns an error if the file can not be created in
	// some way.
	Create(string) (File, error)

	// Open takes a path, opens a potential file and then returns a File if
	// that file exists, otherwise it returns an error if the file wasn't found.
	Open(string) (File, error)

	// OpenFile takes a path, opens a potential file and then returns a File if
	// that file exists, otherwise it returns an error if the file wasn't found.
	OpenFile(path string, flag int, perm os.FileMode) (File, error)

	// Rename takes a current destination path and a new destination path and will
	// rename the a File if it exists, otherwise it returns an error if the file
	// wasn't found.
	Rename(string, string) error

	// Exists takes a path and checks to see if the potential file exists or
	// not.
	// Note: If there is an error trying to read that file, it will return false
	// even if the file already exists.
	Exists(string) bool

	// Remove takes a path, removes a potential file, if no file doesn't exist it
	// will return not found.
	Remove(string) error

	// RemoveAll takes a path, removes all potential files and directories, if
	// no file or directory doesn't exist it will return not found.
	RemoveAll(string) error

	// Mkdir takes a path and generates a directory structure from that path,
	// with the given file mode and if there is a failure it will return an error.
	Mkdir(string, os.FileMode) error

	// MkdirAll takes a path and generates a directory structure from that path,
	// if there is a failure it will return an error.
	MkdirAll(string, os.FileMode) error

	// Chtimes updates the modifier times for a given path or returns an error
	// upon failure
	Chtimes(string, time.Time, time.Time) error

	// Walk over a specific directory and will return an error if there was an
	// error whilst walking.
	Walk(string, filepath.WalkFunc) error

	// Lock attempts to create a locking file for a given path.
	Lock(string) (Releaser, bool, error)

	// CopyFile copies a directory recursively, overwriting the target if it
	// exists.
	CopyFile(string, string) error

	// CopyDir copies a directory recursively, overwriting the target if it
	// exists.
	CopyDir(string, string) error

	// Symlink creates newname as a symbolic link to oldname.
	// If there is an error, it will be of type *LinkError.
	Symlink(string, string) error
}

type LocalFileSystem struct {
	// contains filtered or unexported fields
}

type Option func(*Config) error

type Releaser interface {

	// Release given lock or returns error upon failure.
	Release() error
}

type VirtualFileSystem struct {
	// contains filtered or unexported fields
}