package fs

Import Path
	io/fs (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 18 packages

Involved Source Files

	    format.go
	  d fs.go
		Package fs defines basic interfaces to a file system.
		A file system can be provided by the host operating system
		but also by other packages.
		
		See the [testing/fstest] package for support with testing
		implementations of file systems.

	    glob.go
	    readdir.go
	    readfile.go
	    stat.go
	    sub.go
	    walk.go
Code Examples

	WalkDir
		package main
		
		import (
			"fmt"
			"io/fs"
			"log"
			"os"
		)
		
		func main() {
			root := "/usr/local/go/bin"
			fileSystem := os.DirFS(root)
		
			fs.WalkDir(fileSystem, ".", func(path string, d fs.DirEntry, err error) error {
				if err != nil {
					log.Fatal(err)
				}
				fmt.Println(path)
				return nil
			})
		}


Package-Level Type Names (total 13)

	/* sort by: alphabet | popularity */
	 type DirEntry (interface)
		A DirEntry is an entry read from a directory
		(using the [ReadDir] function or a [ReadDirFile]'s ReadDir method).

		Methods (total 4)
			( DirEntry) Info() (FileInfo, error)
				Info returns the FileInfo for the file or subdirectory described by the entry.
				The returned FileInfo may be from the time of the original directory read
				or from the time of the call to Info. If the file has been removed or renamed
				since the directory read, Info may return an error satisfying errors.Is(err, ErrNotExist).
				If the entry denotes a symbolic link, Info reports the information about the link itself,
				not the link's target.

			( DirEntry) IsDir() bool
				IsDir reports whether the entry describes a directory.

			( DirEntry) Name() string
				Name returns the name of the file (or subdirectory) described by the entry.
				This name is only the final element of the path (the base name), not the entire path.
				For example, Name would return "hello.go" not "home/gopher/hello.go".

			( DirEntry) Type() FileMode
				Type returns the type bits for the entry.
				The type bits are a subset of the usual FileMode bits, those returned by the FileMode.Type method.

		As Outputs Of (at least 8)
			func FileInfoToDirEntry(info FileInfo) DirEntry
			func ReadDir(fsys FS, name string) ([]DirEntry, error)
			func ReadDirFile.ReadDir(n int) ([]DirEntry, error)
			func ReadDirFS.ReadDir(name string) ([]DirEntry, error)
			func embed.FS.ReadDir(name string) ([]DirEntry, error)
			func os.ReadDir(name string) ([]os.DirEntry, error)
			func os.(*File).ReadDir(n int) ([]os.DirEntry, error)
			func testing/fstest.MapFS.ReadDir(name string) ([]DirEntry, error)
		As Inputs Of (at least one exported)
			func FormatDirEntry(dir DirEntry) string

	 type File (interface)
		A File provides access to a single file.
		The File interface is the minimum implementation required of the file.
		Directory files should also implement [ReadDirFile].
		A file may implement [io.ReaderAt] or [io.Seeker] as optimizations.

		Methods (total 3)
			( File) Close() error
			( File) Read([]byte) (int, error)
			( File) Stat() (FileInfo, error)
		Implemented By (at least 3)
			 ReadDirFile (interface)
			 net/http.File (interface)
			*os.File
		Implements (at least 3)
			 File : io.Closer
			 File : io.ReadCloser
			 File : io.Reader
		As Outputs Of (at least 9)
			func FS.Open(name string) (File, error)
			func GlobFS.Open(name string) (File, error)
			func ReadDirFS.Open(name string) (File, error)
			func ReadFileFS.Open(name string) (File, error)
			func StatFS.Open(name string) (File, error)
			func SubFS.Open(name string) (File, error)
			func archive/zip.(*Reader).Open(name string) (File, error)
			func embed.FS.Open(name string) (File, error)
			func testing/fstest.MapFS.Open(name string) (File, error)

	 type FileInfo (interface)
		A FileInfo describes a file and is returned by [Stat].

		Methods (total 6)
			( FileInfo) IsDir() bool
				// abbreviation for Mode().IsDir()

			( FileInfo) ModTime() time.Time
				// modification time

			( FileInfo) Mode() FileMode
				// file mode bits

			( FileInfo) Name() string
				// base name of the file

			( FileInfo) Size() int64
				// length in bytes for regular files; system-dependent for others

			( FileInfo) Sys() any
				// underlying data source (can return nil)

		Implemented By (at least one exported)
			 archive/tar.FileInfoNames (interface)
		As Outputs Of (at least 18)
			func Stat(fsys FS, name string) (FileInfo, error)
			func DirEntry.Info() (FileInfo, error)
			func File.Stat() (FileInfo, error)
			func ReadDirFile.Stat() (FileInfo, error)
			func StatFS.Stat(name string) (FileInfo, error)
			func io/ioutil.ReadDir(dirname string) ([]FileInfo, error)
			func archive/tar.(*Header).FileInfo() FileInfo
			func archive/zip.(*FileHeader).FileInfo() FileInfo
			func net/http.File.Readdir(count int) ([]FileInfo, error)
			func net/http.File.Stat() (FileInfo, error)
			func os.Lstat(name string) (os.FileInfo, error)
			func os.Stat(name string) (os.FileInfo, error)
			func os.DirEntry.Info() (FileInfo, error)
			func os.(*File).Readdir(n int) ([]os.FileInfo, error)
			func os.(*File).Stat() (os.FileInfo, error)
			func os.(*Root).Lstat(name string) (os.FileInfo, error)
			func os.(*Root).Stat(name string) (os.FileInfo, error)
			func testing/fstest.MapFS.Stat(name string) (FileInfo, error)
		As Inputs Of (at least 5)
			func FileInfoToDirEntry(info FileInfo) DirEntry
			func FormatFileInfo(info FileInfo) string
			func archive/tar.FileInfoHeader(fi FileInfo, link string) (*tar.Header, error)
			func archive/zip.FileInfoHeader(fi FileInfo) (*zip.FileHeader, error)
			func os.SameFile(fi1, fi2 os.FileInfo) bool

	 type FileMode uint32 (basic type)
		A FileMode represents a file's mode and permission bits.
		The bits have the same definition on all systems, so that
		information about files can be moved from one system
		to another portably. Not all bits apply to all systems.
		The only required bit is [ModeDir] for directories.

		Methods (total 5)
			( FileMode) IsDir() bool
				IsDir reports whether m describes a directory.
				That is, it tests for the [ModeDir] bit being set in m.

			( FileMode) IsRegular() bool
				IsRegular reports whether m describes a regular file.
				That is, it tests that no mode type bits are set.

			( FileMode) Perm() FileMode
				Perm returns the Unix permission bits in m (m & [ModePerm]).

			( FileMode) String() string
			( FileMode) Type() FileMode
				Type returns type bits in m (m & [ModeType]).

		Implements (at least 2)
			 FileMode : expvar.Var
			 FileMode : fmt.Stringer
		As Outputs Of (at least 8)
			func DirEntry.Type() FileMode
			func FileInfo.Mode() FileMode
			func FileMode.Perm() FileMode
			func FileMode.Type() FileMode
			func archive/tar.FileInfoNames.Mode() FileMode
			func archive/zip.(*FileHeader).Mode() (mode FileMode)
			func os.DirEntry.Type() FileMode
			func os.FileInfo.Mode() FileMode
		As Inputs Of (at least 10)
			func io/ioutil.WriteFile(filename string, data []byte, perm FileMode) error
			func archive/zip.(*FileHeader).SetMode(mode FileMode)
			func os.Chmod(name string, mode os.FileMode) error
			func os.Mkdir(name string, perm os.FileMode) error
			func os.MkdirAll(path string, perm os.FileMode) error
			func os.OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)
			func os.WriteFile(name string, data []byte, perm os.FileMode) error
			func os.(*File).Chmod(mode os.FileMode) error
			func os.(*Root).Mkdir(name string, perm os.FileMode) error
			func os.(*Root).OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)
		As Types Of (total 30)
			const ModeAppend
			const ModeCharDevice
			const ModeDevice
			const ModeDir
			const ModeExclusive
			const ModeIrregular
			const ModeNamedPipe
			const ModePerm
			const ModeSetgid
			const ModeSetuid
			const ModeSocket
			const ModeSticky
			const ModeSymlink
			const ModeTemporary
			const ModeType
			const os.ModeAppend
			const os.ModeCharDevice
			const os.ModeDevice
			const os.ModeDir
			const os.ModeExclusive
			const os.ModeIrregular
			const os.ModeNamedPipe
			const os.ModePerm
			const os.ModeSetgid
			const os.ModeSetuid
			const os.ModeSocket
			const os.ModeSticky
			const os.ModeSymlink
			const os.ModeTemporary
			const os.ModeType

	 type FS (interface)
		An FS provides access to a hierarchical file system.
		
		The FS interface is the minimum implementation required of the file system.
		A file system may implement additional interfaces,
		such as [ReadFileFS], to provide additional or optimized functionality.
		
		[testing/fstest.TestFS] may be used to test implementations of an FS for
		correctness.

		Methods (only one)
			( FS) Open(name string) (File, error)
				Open opens the named file.
				[File.Close] must be called to release any associated resources.
				
				When Open returns an error, it should be of type *PathError
				with the Op field set to "open", the Path field set to name,
				and the Err field describing the problem.
				
				Open should reject attempts to open names that do not satisfy
				ValidPath(name), returning a *PathError with Err set to
				ErrInvalid or ErrNotExist.

		Implemented By (at least 9)
			 GlobFS (interface)
			 ReadDirFS (interface)
			 ReadFileFS (interface)
			 StatFS (interface)
			 SubFS (interface)
			*archive/zip.ReadCloser
			*archive/zip.Reader
			 embed.FS
			 testing/fstest.MapFS
		As Outputs Of (at least 5)
			func Sub(fsys FS, dir string) (FS, error)
			func SubFS.Sub(dir string) (FS, error)
			func os.DirFS(dir string) FS
			func os.(*Root).FS() FS
			func testing/fstest.MapFS.Sub(dir string) (FS, error)
		As Inputs Of (at least 18)
			func Glob(fsys FS, pattern string) (matches []string, err error)
			func ReadDir(fsys FS, name string) ([]DirEntry, error)
			func ReadFile(fsys FS, name string) ([]byte, error)
			func Stat(fsys FS, name string) (FileInfo, error)
			func Sub(fsys FS, dir string) (FS, error)
			func WalkDir(fsys FS, root string, fn WalkDirFunc) error
			func archive/tar.(*Writer).AddFS(fsys FS) error
			func archive/zip.(*Writer).AddFS(fsys FS) error
			func html/template.ParseFS(fs FS, patterns ...string) (*template.Template, error)
			func html/template.(*Template).ParseFS(fs FS, patterns ...string) (*template.Template, error)
			func net/http.FileServerFS(root FS) http.Handler
			func net/http.FS(fsys FS) http.FileSystem
			func net/http.NewFileTransportFS(fsys FS) http.RoundTripper
			func net/http.ServeFileFS(w http.ResponseWriter, r *http.Request, fsys FS, name string)
			func os.CopyFS(dir string, fsys FS) error
			func testing/fstest.TestFS(fsys FS, expected ...string) error
			func text/template.ParseFS(fsys FS, patterns ...string) (*template.Template, error)
			func text/template.(*Template).ParseFS(fsys FS, patterns ...string) (*template.Template, error)

	 type GlobFS (interface)
		A GlobFS is a file system with a Glob method.

		Methods (total 2)
			( GlobFS) Glob(pattern string) ([]string, error)
				Glob returns the names of all files matching pattern,
				providing an implementation of the top-level
				Glob function.

			( GlobFS) Open(name string) (File, error)
				Open opens the named file.
				[File.Close] must be called to release any associated resources.
				
				When Open returns an error, it should be of type *PathError
				with the Op field set to "open", the Path field set to name,
				and the Err field describing the problem.
				
				Open should reject attempts to open names that do not satisfy
				ValidPath(name), returning a *PathError with Err set to
				ErrInvalid or ErrNotExist.

		Implemented By (at least one exported)
			 testing/fstest.MapFS
		Implements (at least one exported)
			 GlobFS : FS

	 type PathError (struct)
		PathError records an error and the operation and file path that caused it.

		Fields (total 3)
			Err error
			Op string
			Path string
		Methods (total 3)
			(*PathError) Error() string
			(*PathError) Timeout() bool
				Timeout reports whether this error represents a timeout.

			(*PathError) Unwrap() error
		Implements (at least one exported)
			*PathError : error

	 type ReadDirFile (interface)
		A ReadDirFile is a directory file whose entries can be read with the ReadDir method.
		Every directory file should implement this interface.
		(It is permissible for any file to implement this interface,
		but if so ReadDir should return an error for non-directories.)

		Methods (total 4)
			( ReadDirFile) Close() error
			( ReadDirFile) Read([]byte) (int, error)
			( ReadDirFile) ReadDir(n int) ([]DirEntry, error)
				ReadDir reads the contents of the directory and returns
				a slice of up to n DirEntry values in directory order.
				Subsequent calls on the same file will yield further DirEntry values.
				
				If n > 0, ReadDir returns at most n DirEntry structures.
				In this case, if ReadDir returns an empty slice, it will return
				a non-nil error explaining why.
				At the end of a directory, the error is io.EOF.
				(ReadDir must return io.EOF itself, not an error wrapping io.EOF.)
				
				If n <= 0, ReadDir returns all the DirEntry values from the directory
				in a single slice. In this case, if ReadDir succeeds (reads all the way
				to the end of the directory), it returns the slice and a nil error.
				If it encounters an error before the end of the directory,
				ReadDir returns the DirEntry list read until that point and a non-nil error.

			( ReadDirFile) Stat() (FileInfo, error)
		Implemented By (at least one exported)
			*os.File
		Implements (at least 4)
			 ReadDirFile : File
			 ReadDirFile : io.Closer
			 ReadDirFile : io.ReadCloser
			 ReadDirFile : io.Reader

	 type ReadDirFS (interface)
		ReadDirFS is the interface implemented by a file system
		that provides an optimized implementation of [ReadDir].

		Methods (total 2)
			( ReadDirFS) Open(name string) (File, error)
				Open opens the named file.
				[File.Close] must be called to release any associated resources.
				
				When Open returns an error, it should be of type *PathError
				with the Op field set to "open", the Path field set to name,
				and the Err field describing the problem.
				
				Open should reject attempts to open names that do not satisfy
				ValidPath(name), returning a *PathError with Err set to
				ErrInvalid or ErrNotExist.

			( ReadDirFS) ReadDir(name string) ([]DirEntry, error)
				ReadDir reads the named directory
				and returns a list of directory entries sorted by filename.

		Implemented By (at least 2)
			 embed.FS
			 testing/fstest.MapFS
		Implements (at least one exported)
			 ReadDirFS : FS

	 type ReadFileFS (interface)
		ReadFileFS is the interface implemented by a file system
		that provides an optimized implementation of [ReadFile].

		Methods (total 2)
			( ReadFileFS) Open(name string) (File, error)
				Open opens the named file.
				[File.Close] must be called to release any associated resources.
				
				When Open returns an error, it should be of type *PathError
				with the Op field set to "open", the Path field set to name,
				and the Err field describing the problem.
				
				Open should reject attempts to open names that do not satisfy
				ValidPath(name), returning a *PathError with Err set to
				ErrInvalid or ErrNotExist.

			( ReadFileFS) ReadFile(name string) ([]byte, error)
				ReadFile reads the named file and returns its contents.
				A successful call returns a nil error, not io.EOF.
				(Because ReadFile reads the whole file, the expected EOF
				from the final Read is not treated as an error to be reported.)
				
				The caller is permitted to modify the returned byte slice.
				This method should return a copy of the underlying data.

		Implemented By (at least 2)
			 embed.FS
			 testing/fstest.MapFS
		Implements (at least one exported)
			 ReadFileFS : FS

	 type StatFS (interface)
		A StatFS is a file system with a Stat method.

		Methods (total 2)
			( StatFS) Open(name string) (File, error)
				Open opens the named file.
				[File.Close] must be called to release any associated resources.
				
				When Open returns an error, it should be of type *PathError
				with the Op field set to "open", the Path field set to name,
				and the Err field describing the problem.
				
				Open should reject attempts to open names that do not satisfy
				ValidPath(name), returning a *PathError with Err set to
				ErrInvalid or ErrNotExist.

			( StatFS) Stat(name string) (FileInfo, error)
				Stat returns a FileInfo describing the file.
				If there is an error, it should be of type *PathError.

		Implemented By (at least one exported)
			 testing/fstest.MapFS
		Implements (at least one exported)
			 StatFS : FS

	 type SubFS (interface)
		A SubFS is a file system with a Sub method.

		Methods (total 2)
			( SubFS) Open(name string) (File, error)
				Open opens the named file.
				[File.Close] must be called to release any associated resources.
				
				When Open returns an error, it should be of type *PathError
				with the Op field set to "open", the Path field set to name,
				and the Err field describing the problem.
				
				Open should reject attempts to open names that do not satisfy
				ValidPath(name), returning a *PathError with Err set to
				ErrInvalid or ErrNotExist.

			( SubFS) Sub(dir string) (FS, error)
				Sub returns an FS corresponding to the subtree rooted at dir.

		Implemented By (at least one exported)
			 testing/fstest.MapFS
		Implements (at least one exported)
			 SubFS : FS

	 type WalkDirFunc (func)
		WalkDirFunc is the type of the function called by [WalkDir] to visit
		each file or directory.
		
		The path argument contains the argument to [WalkDir] as a prefix.
		That is, if WalkDir is called with root argument "dir" and finds a file
		named "a" in that directory, the walk function will be called with
		argument "dir/a".
		
		The d argument is the [DirEntry] for the named path.
		
		The error result returned by the function controls how [WalkDir]
		continues. If the function returns the special value [SkipDir], WalkDir
		skips the current directory (path if d.IsDir() is true, otherwise
		path's parent directory). If the function returns the special value
		[SkipAll], WalkDir skips all remaining files and directories. Otherwise,
		if the function returns a non-nil error, WalkDir stops entirely and
		returns that error.
		
		The err argument reports an error related to path, signaling that
		[WalkDir] will not walk into that directory. The function can decide how
		to handle that error; as described earlier, returning the error will
		cause WalkDir to stop walking the entire tree.
		
		[WalkDir] calls the function with a non-nil err argument in two cases.
		
		First, if the initial [Stat] on the root directory fails, WalkDir
		calls the function with path set to root, d set to nil, and err set to
		the error from [fs.Stat].
		
		Second, if a directory's ReadDir method (see [ReadDirFile]) fails, WalkDir calls the
		function with path set to the directory's path, d set to an
		[DirEntry] describing the directory, and err set to the error from
		ReadDir. In this second case, the function is called twice with the
		path of the directory: the first call is before the directory read is
		attempted and has err set to nil, giving the function a chance to
		return [SkipDir] or [SkipAll] and avoid the ReadDir entirely. The second call
		is after a failed ReadDir and reports the error from ReadDir.
		(If ReadDir succeeds, there is no second call.)
		
		The differences between WalkDirFunc compared to [path/filepath.WalkFunc] are:
		
		  - The second argument has type [DirEntry] instead of [FileInfo].
		  - The function is called before reading a directory, to allow [SkipDir]
		    or [SkipAll] to bypass the directory read entirely or skip all remaining
		    files and directories respectively.
		  - If a directory read fails, the function is called a second time
		    for that directory to report the error.

		As Inputs Of (at least 2)
			func WalkDir(fsys FS, root string, fn WalkDirFunc) error
			func path/filepath.WalkDir(root string, fn WalkDirFunc) error


Package-Level Functions (total 10)

	 func FileInfoToDirEntry(info FileInfo) DirEntry
		FileInfoToDirEntry returns a [DirEntry] that returns information from info.
		If info is nil, FileInfoToDirEntry returns nil.

	 func FormatDirEntry(dir DirEntry) string
		FormatDirEntry returns a formatted version of dir for human readability.
		Implementations of [DirEntry] can call this from a String method.
		The outputs for a directory named subdir and a file named hello.go are:
		
			d subdir/
			- hello.go

	 func FormatFileInfo(info FileInfo) string
		FormatFileInfo returns a formatted version of info for human readability.
		Implementations of [FileInfo] can call this from a String method.
		The output for a file named "hello.go", 100 bytes, mode 0o644, created
		January 1, 1970 at noon is
		
			-rw-r--r-- 100 1970-01-01 12:00:00 hello.go

	 func Glob(fsys FS, pattern string) (matches []string, err error)
		Glob returns the names of all files matching pattern or nil
		if there is no matching file. The syntax of patterns is the same
		as in [path.Match]. The pattern may describe hierarchical names such as
		usr/*/bin/ed.
		
		Glob ignores file system errors such as I/O errors reading directories.
		The only possible returned error is [path.ErrBadPattern], reporting that
		the pattern is malformed.
		
		If fs implements [GlobFS], Glob calls fs.Glob.
		Otherwise, Glob uses [ReadDir] to traverse the directory tree
		and look for matches for the pattern.

	 func ReadDir(fsys FS, name string) ([]DirEntry, error)
		ReadDir reads the named directory
		and returns a list of directory entries sorted by filename.
		
		If fs implements [ReadDirFS], ReadDir calls fs.ReadDir.
		Otherwise ReadDir calls fs.Open and uses ReadDir and Close
		on the returned file.

	 func ReadFile(fsys FS, name string) ([]byte, error)
		ReadFile reads the named file from the file system fs and returns its contents.
		A successful call returns a nil error, not [io.EOF].
		(Because ReadFile reads the whole file, the expected EOF
		from the final Read is not treated as an error to be reported.)
		
		If fs implements [ReadFileFS], ReadFile calls fs.ReadFile.
		Otherwise ReadFile calls fs.Open and uses Read and Close
		on the returned [File].

	 func Stat(fsys FS, name string) (FileInfo, error)
		Stat returns a [FileInfo] describing the named file from the file system.
		
		If fs implements [StatFS], Stat calls fs.Stat.
		Otherwise, Stat opens the [File] to stat it.

	 func Sub(fsys FS, dir string) (FS, error)
		Sub returns an [FS] corresponding to the subtree rooted at fsys's dir.
		
		If dir is ".", Sub returns fsys unchanged.
		Otherwise, if fs implements [SubFS], Sub returns fsys.Sub(dir).
		Otherwise, Sub returns a new [FS] implementation sub that,
		in effect, implements sub.Open(name) as fsys.Open(path.Join(dir, name)).
		The implementation also translates calls to ReadDir, ReadFile, and Glob appropriately.
		
		Note that Sub(os.DirFS("/"), "prefix") is equivalent to os.DirFS("/prefix")
		and that neither of them guarantees to avoid operating system
		accesses outside "/prefix", because the implementation of [os.DirFS]
		does not check for symbolic links inside "/prefix" that point to
		other directories. That is, [os.DirFS] is not a general substitute for a
		chroot-style security mechanism, and Sub does not change that fact.

	 func ValidPath(name string) bool
		ValidPath reports whether the given path name
		is valid for use in a call to Open.
		
		Path names passed to open are UTF-8-encoded,
		unrooted, slash-separated sequences of path elements, like “x/y/z”.
		Path names must not contain an element that is “.” or “..” or the empty string,
		except for the special case that the name "." may be used for the root directory.
		Paths must not start or end with a slash: “/x” and “x/” are invalid.
		
		Note that paths are slash-separated on all systems, even Windows.
		Paths containing other characters such as backslash and colon
		are accepted as valid, but those characters must never be
		interpreted by an [FS] implementation as path element separators.

	 func WalkDir(fsys FS, root string, fn WalkDirFunc) error
		WalkDir walks the file tree rooted at root, calling fn for each file or
		directory in the tree, including root.
		
		All errors that arise visiting files and directories are filtered by fn:
		see the [fs.WalkDirFunc] documentation for details.
		
		The files are walked in lexical order, which makes the output deterministic
		but requires WalkDir to read an entire directory into memory before proceeding
		to walk that directory.
		
		WalkDir does not follow symbolic links found in directories,
		but if root itself is a symbolic link, its target will be walked.


Package-Level Variables (total 7)

	  var ErrClosed error // "file already closed"
		Generic file system errors.
		Errors returned by file systems can be tested against these errors
		using [errors.Is].

	  var ErrExist error // "file already exists"
		Generic file system errors.
		Errors returned by file systems can be tested against these errors
		using [errors.Is].

	  var ErrInvalid error // "invalid argument"
		Generic file system errors.
		Errors returned by file systems can be tested against these errors
		using [errors.Is].

	  var ErrNotExist error // "file does not exist"
		Generic file system errors.
		Errors returned by file systems can be tested against these errors
		using [errors.Is].

	  var ErrPermission error // "permission denied"
		Generic file system errors.
		Errors returned by file systems can be tested against these errors
		using [errors.Is].

	  var SkipAll error
		SkipAll is used as a return value from [WalkDirFunc] to indicate that
		all remaining files and directories are to be skipped. It is not returned
		as an error by any function.

	  var SkipDir error
		SkipDir is used as a return value from [WalkDirFunc] to indicate that
		the directory named in the call is to be skipped. It is not returned
		as an error by any function.


Package-Level Constants (total 15)

	const ModeAppend FileMode = 1073741824 // a: append-only
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeCharDevice FileMode = 2097152 // c: Unix character device, when ModeDevice is set
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeDevice FileMode = 67108864 // D: device file
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeDir FileMode = 2147483648 // d: is a directory
		The single letters are the abbreviations
		used by the String method's formatting.

	const ModeExclusive FileMode = 536870912 // l: exclusive use
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeIrregular FileMode = 524288 // ?: non-regular file; nothing else is known about this file
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeNamedPipe FileMode = 33554432 // p: named pipe (FIFO)
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModePerm FileMode = 511 // Unix permission bits
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeSetgid FileMode = 4194304 // g: setgid
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeSetuid FileMode = 8388608 // u: setuid
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeSocket FileMode = 16777216 // S: Unix domain socket
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeSticky FileMode = 1048576 // t: sticky
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeSymlink FileMode = 134217728 // L: symbolic link
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeTemporary FileMode = 268435456 // T: temporary file; Plan 9 only
		The defined file mode bits are the most significant bits of the [FileMode].
		The nine least-significant bits are the standard Unix rwxrwxrwx permissions.
		The values of these bits should be considered part of the public API and
		may be used in wire protocols or disk representations: they must not be
		changed, although new bits might be added.

	const ModeType FileMode = 2401763328
		Mask for the type bits. For regular files, none will be set.

The pages are generated with Golds v0.7.6-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.