# Functions
Chmod changes the file mode of a filesystem item.
No description provided by the author
ConvertFileSystemError converts file system error into common errors.
ConvertFromIOFilesystem converts an io/fs FS into a FS.
ConvertToIOFilesystem converts a filesystem FS to a io/fs FS.
ConvertToOSFile converts a file to a `os` implementation of a file for certain use-cases where functions have not moved to using `fs.File`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CopyToDirectory copies a src to a directory destDirectory which will be created as such if not present.
CopyToDirectoryWithContext copies a src to a directory destDirectory which will be created as such if not present.
CopyToFile copies a file into another file.
CopyToFileWithContext copies a file into another file.
No description provided by the author
No description provided by the author
DefaultLimits defines default file system limits.
DefaultNonRecursiveZipLimits defines default file system limits for handling zips.
DefaultZipLimits defines default file system limits for handling zips.
No description provided by the author
EndsWithPathSeparator states whether a path is ending with a path separator of not.
ExcludeAll excludes files.
No description provided by the author
Exists checks if a file or folder exists.
FilepathParents returns a list of to the logical ancestors of the path and it's similar to `parents` in python's [pathlib](https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.parents).
FilePathParentsOnFilesystem is similar to FilepathParents but with the ability to be applied to a particular filesystem.
FilepathStem returns the final path component, without its suffix.
FileTreeDepth returns the depth of a file in a tree starting from root.
FindAll finds all the files with extensions.
GenerateTestFileTree generates a file tree for testing purposes and returns a list of all the files and filesystem items created.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Glob returns the names of all files matching pattern with support for "doublestar" (aka globstar: **) patterns You can find the children with patterns such as: **/child*, grandparent/**/child?, **/parent/*, or even just ** by itself (which will return all files and directories recursively).
No description provided by the author
IsDir states whether it is a directory or not.
No description provided by the author
IsEmpty checks whether a path is empty or not.
IsFile states whether it is a file or not.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ListDirTree returns a list of files and directories recursively available under specified path.
No description provided by the author
No description provided by the author
LsRecursive lists all files recursively, including subdirectories.
LsRecursiveWithExclusionPatterns lists all files and directory (equivalent to ls) but exclude the ones matching the exclusion patterns.
No description provided by the author
No description provided by the author
MkDir makes directory (equivalent to mkdir -p).
Move moves a file (equivalent to mv).
No description provided by the author
NewCloseableVirtualFileSystem returns a virtual filesystem which requires closing after use.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewGenericRemoteLockFile creates a new remote lock using the file system.
No description provided by the author
NewLimits defines file system FileSystemLimits.
NewOSPathExistRule returns a validation rule to use in configuration.
NewOSPathValidationRule returns a validation rule to use in configuration.
NewPathExistRule returns a validation rule to use in configuration.
NewPathValidationRule returns a validation rule to use in configuration.
NewRemoteLockFile creates a new remote lock using the file system.
No description provided by the author
NewVirtualFileSystem returns a virtual filesystem similarly to NewCloseableVirtualFileSystem.
NewZipFileSystem returns a filesystem over the contents of a .zip file.
NewZipFileSystemFromStandardFileSystem returns a zip filesystem similar to NewZipFileSystem but assumes the zip file described by source can be found on the standard file system.
NoLimits defines no file system FileSystemLimits.
No description provided by the author
No description provided by the author
No description provided by the author
ReadFileContent reads the file content.
No description provided by the author
RecursiveZipLimits defines file system limits for handling zips recursively.
RemoveWithPrivileges removes any directory (equivalent to `sudo rm -rf`).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TouchTempFile creates an empty file in `dir` and returns it filename.
TouchTempFileInTempDir creates an empty file in temp directory and returns it filename.
Unzip unzips an source archive file into destination.
UnzipWithContextAndLimits unzips an source archive file into destination.
WriteFile writes data to a file.
Zip zips a source directory into a destination archive.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ZipFileExtensions returns a list of commonly used extensions to describe zip archive files This list was populated from [Wikipedia](https://en.wikipedia.org/wiki/List_of_archive_formats).
ZipMimeTypes returns a list of MIME types describing zip archive files.
# Structs
ExtendedOsFs extends afero.OsFs and is a Fs implementation that uses functions provided by the os package.
Limits defines file system limits.
RemoteLockFile describes a distributed lock using only the file system.
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
FS defines all the methods a file system should provide.
IChowner is an Optional interface.
ICloseableFS is a filesystem which utilises resources which must be closed when it is no longer used, such as open files.
IFileHash defines a file hash.
IForceRemover is an Optional interface.
ILimits defines general FileSystemLimits for actions performed on the filesystem.
ILinker is an Optional interface.
ILinkReader is an Optional interface.
ILock defines a generic lock using the file system.
IStater is an Optional interface.
ISymLinker is an Optional interface.
# Type aliases
No description provided by the author