# README
vfs
vfs implements Virtual File Systems with read-write support in Go (golang)
# Functions
Chroot returns a new VFS wrapping the given VFS, making the given directory the new root ("/").
Clone copies all the files from the src VFS to dst.
Compress is a shorthand method for compressing all the files in a VFS.
FS returns a VFS at the given path, which must be provided as native path of the current operating system.
IsExist returns wheter the error indicates that the file or directory already exists.
IsExist returns wheter the error indicates that the file or directory does not exist.
Map returns an in-memory file system using the given files argument to populate it (which might be nil).
Memory returns an empty in memory VFS.
MkdirAll makes all directories pointed by the given path, using the same permissions for all of them.
NewRFile returns a RFile from a *File.
NewWFile returns a WFile from a *File.
Open returns an in-memory VFS initialized with the contents of the given filename, which must have one of the following extensions:
- .zip - .tar - .tar.gz - .tar.bz2.
ReadFile reads the file at the given path from the given fs, returning either its contents or an error if the file couldn't be read.
ReadOnly returns a read-only filesystem wrapping the given fs.
RemoveAll removes all files from the given fs and path, including directories (by removing its contents first).
Rewriter returns a file system which uses the provided function to rewrite paths.
Tar returns an in-memory VFS initialized with the contents of the .tar file read from the given io.Reader.
TarBzip2 returns an in-memory VFS initialized with the contents of then .tar.bz2 file read from the given io.Reader.
TarGzip returns an in-memory VFS initialized with the contents of the .tar.gz file read from the given io.Reader.
TmpFS returns a temporary file system with the given prefix and its root directory name, which might be empty.
Walk iterates over all the files in the VFS which descend from the given root (including root itself), descending into any subdirectories.
WriteFile writes a file at the given path and fs with the given data and permissions.
WriteTar writes the given VFS as a tar file to the given io.Writer.
WriteTarGzip writes the given VFS as a tar.gz file to the given io.Writer.
WriteZip writes the given VFS as a zip file to the given io.Writer.
Zip returns an in-memory VFS initialized with the contents of the .zip file read from the given io.Reader.
# Constants
EntryTypeDir indicates the entry is a directory.
EntryTypeFile indicates the entry is a file.
No description provided by the author
# Variables
ErrReadOnly is returned from Write() on a read-only file.
ErrReadOnlyFileSystem is the error returned by read only file systems from calls which would result in a write operation.
ErrWriteOnly is returned from Read() on a write-only file.
SkipDir is used by a WalkFunc to signal Walk that it wans to skip the given directory.
# Structs
Type Dir represents an in-memory directory.
EntryInfo implements the os.FileInfo interface wrapping a given File and its Path in its VFS.
Type File represents an in-memory file.
Mounter implements the VFS interface and allows mounting different virtual file systems at arbitraty points, working much like a UNIX filesystem.
# Interfaces
Compressor is the interface implemented by VFS files which can be transparently compressed and decompressed.
Container is implemented by some file systems which contain another one.
Entry is the interface implemented by the in-memory representations of files and directories.
Opener is the interface which specifies the methods for opening a file.
RFile is the interface implemented by the returned value from a VFS Open method.
TemporaryVFS represents a temporary on-disk file system which can be removed by calling its Close method.
VFS is the interface implemented by all the Virtual File Systems.
WFile is the interface implemented by the returned value from a VFS OpenFile method.