filesystem

type FS interface {

	// RootDir returns the Root directory of the file system
	RootDir() string
	// Dir returns a list of files in the given directory
	Dir(folderName string) ([]string, []os.FileInfo, error)
	// CheckDir checks if the given directory exists
	CheckDir(string) error
	// MakeDir creates a new directory with the given name
	MakeDir(folderName string) error
	// ReadFile reads the file and writes it to the given writer
	ReadFile(string, io.Writer) (int64, error)
	// WriteFile creates a new file with the given name and writes the data from the reader
	// filename is the name of the file to create
	// r is the reader that contains the data to write to the file
	// transferType is the transfer type "A" for ASCII or "I" for binary
	// appendOnly is true if the file should be opened in append mode not rewrite mode
	WriteFile(fileName string, r io.Reader, transferType string, appendOnly bool) error
	// Remove removes the file
	// fileName is the name of the file to remove
	Remove(fileName string) error
	// Rename renames the file/folder or moves it to a different directory
	Rename(original string, target string) error
	// ModifyTime changes the file modification time
	ModifyTime(string, string) error
	// Stat returns the file info without following the link
	Stat(fileName string) (string, fs.FileInfo, error)
	// SetStat changes the file info
	SetStat(fileName string, newPermissions os.FileMode) error
	// Lstat returns the file info without following the link
	Lstat(fileName string) (string, fs.FileInfo, error)
	// Link creates a hard link pointing to a file.
	Link(fileName string, target string) error
	// Symlink creates a symbolic link pointing to a file or directory.
	Symlink(fileName string, target string) error
}

type FSWithReadWriteAt interface {
	FS

	// FileWrite creates/update a new file with the given name and writes the data from the reader
	FileWrite(fileName string, access int) (io.WriterAt, error)

	// FileRead reads the file at the given offset and writes it to the given writer
	FileRead(fileName string, access int) (io.ReaderAt, error)
	// StatFS FileStatFS returns the file system status of the file system containing the file
	StatFS(path string) (*sftp.StatVFS, error)
}

type LocalFS struct {
	FS fs.FS
	// contains filtered or unexported fields
}

type NewFS interface {
	FS
	// GetFS returns the fs.FS object
	GetFS() fs.FS
}

type NewFSWithReadWriteAt interface {
	NewFS
	FSWithReadWriteAt
}