"os"
"strings"
"syscall"
"strings"
"syscall"
"strings"
"os"
"strings"
"syscall"
"errors"
"internal/filepathlite"
"io/fs"
"os"
"runtime"
"syscall"
"errors"
"internal/filepathlite"
"os"
"runtime"
"slices"
"strings"
"unicode/utf8"
"errors"
"internal/bytealg"
"internal/filepathlite"
"io/fs"
"os"
"slices"
"strings"
ErrBadPattern indicates a pattern was malformed.
var ErrBadPattern = *ast.CallExprconst ListSeparator = os.PathListSeparatorconst Separator = os.PathSeparatorSkipAll is used as a return value from [WalkFunc] to indicate that all remaining files and directories are to be skipped. It is not returned as an error by any function.
var SkipAll error = fs.SkipAllSkipDir is used as a return value from [WalkFunc] to indicate that the directory named in the call is to be skipped. It is not returned as an error by any function.
var SkipDir error = fs.SkipDirvar lstat = os.LstatWalkFunc is the type of the function called by [Walk] to visit each file or directory. The path argument contains the argument to Walk as a prefix. That is, if Walk 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 directory and file are joined with Join, which may clean the directory name: if Walk is called with the root argument "x/../dir" and finds a file named "a" in that directory, the walk function will be called with argument "dir/a", not "x/../dir/a". The info argument is the fs.FileInfo for the named path. The error result returned by the function controls how Walk continues. If the function returns the special value [SkipDir], Walk skips the current directory (path if info.IsDir() is true, otherwise path's parent directory). If the function returns the special value [SkipAll], Walk skips all remaining files and directories. Otherwise, if the function returns a non-nil error, Walk stops entirely and returns that error. The err argument reports an error related to path, signaling that Walk will not walk into that directory. The function can decide how to handle that error; as described earlier, returning the error will cause Walk to stop walking the entire tree. Walk calls the function with a non-nil err argument in two cases. First, if an [os.Lstat] on the root directory or any directory or file in the tree fails, Walk calls the function with path set to that directory or file's path, info set to nil, and err set to the error from os.Lstat. Second, if a directory's Readdirnames method fails, Walk calls the function with path set to the directory's path, info, set to an [fs.FileInfo] describing the directory, and err set to the error from Readdirnames.
type WalkFunc func(path string, info fs.FileInfo, err error) errorAbs returns an absolute representation of path. If the path is not absolute it will be joined with the current working directory to turn it into an absolute path. The absolute path name for a given file is not guaranteed to be unique. Abs calls [Clean] on the result.
func Abs(path string) (string, error)Base returns the last element of path. Trailing path separators are removed before extracting the last element. If the path is empty, Base returns ".". If the path consists entirely of separators, Base returns a single separator.
func Base(path string) stringClean returns the shortest path name equivalent to path by purely lexical processing. It applies the following rules iteratively until no further processing can be done: 1. Replace multiple [Separator] elements with a single one. 2. Eliminate each . path name element (the current directory). 3. Eliminate each inner .. path name element (the parent directory) along with the non-.. element that precedes it. 4. Eliminate .. elements that begin a rooted path: that is, replace "/.." by "/" at the beginning of a path, assuming Separator is '/'. The returned path ends in a slash only if it represents a root directory, such as "/" on Unix or `C:\` on Windows. Finally, any occurrences of slash are replaced by Separator. If the result of this process is an empty string, Clean returns the string ".". On Windows, Clean does not modify the volume name other than to replace occurrences of "/" with `\`. For example, Clean("//host/share/../x") returns `\\host\share\x`. See also Rob Pike, “Lexical File Names in Plan 9 or Getting Dot-Dot Right,” https://9p.io/sys/doc/lexnames.html
func Clean(path string) stringDir returns all but the last element of path, typically the path's directory. After dropping the final element, Dir calls [Clean] on the path and trailing slashes are removed. If the path is empty, Dir returns ".". If the path consists entirely of separators, Dir returns a single separator. The returned path does not end in a separator unless it is the root directory.
func Dir(path string) stringEvalSymlinks returns the path name after the evaluation of any symbolic links. If path is relative the result will be relative to the current directory, unless one of the components is an absolute symbolic link. EvalSymlinks calls [Clean] on the result.
func EvalSymlinks(path string) (string, error)Ext returns the file name extension used by path. The extension is the suffix beginning at the final dot in the final element of path; it is empty if there is no dot.
func Ext(path string) stringFromSlash returns the result of replacing each slash ('/') character in path with a separator character. Multiple slashes are replaced by multiple separators. See also the Localize function, which converts a slash-separated path as used by the io/fs package to an operating system path.
func FromSlash(path string) stringGlob 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 [Match]. The pattern may describe hierarchical names such as /usr/*/bin/ed (assuming the [Separator] is '/'). Glob ignores file system errors such as I/O errors reading directories. The only possible returned error is [ErrBadPattern], when pattern is malformed.
func Glob(pattern string) (matches []string, err error)HasPrefix exists for historical compatibility and should not be used. Deprecated: HasPrefix does not respect path boundaries and does not ignore case when required.
func HasPrefix(p string, prefix string) boolHasPrefix exists for historical compatibility and should not be used. Deprecated: HasPrefix does not respect path boundaries and does not ignore case when required.
func HasPrefix(p string, prefix string) boolHasPrefix exists for historical compatibility and should not be used. Deprecated: HasPrefix does not respect path boundaries and does not ignore case when required.
func HasPrefix(p string, prefix string) boolIsAbs reports whether the path is absolute.
func IsAbs(path string) boolIsLocal reports whether path, using lexical analysis only, has all of these properties: - is within the subtree rooted at the directory in which path is evaluated - is not an absolute path - is not empty - on Windows, is not a reserved name such as "NUL" If IsLocal(path) returns true, then Join(base, path) will always produce a path contained within base and Clean(path) will always produce an unrooted path with no ".." path elements. IsLocal is a purely lexical operation. In particular, it does not account for the effect of any symbolic links that may exist in the filesystem.
func IsLocal(path string) boolJoin joins any number of path elements into a single path, separating them with an OS specific [Separator]. Empty elements are ignored. The result is Cleaned. However, if the argument list is empty or all its elements are empty, Join returns an empty string. On Windows, the result will only be a UNC path if the first non-empty element is a UNC path.
func Join(elem ...string) stringLocalize converts a slash-separated path into an operating system path. The input path must be a valid path as reported by [io/fs.ValidPath]. Localize returns an error if the path cannot be represented by the operating system. For example, the path a\b is rejected on Windows, on which \ is a separator character and cannot be part of a filename. The path returned by Localize will always be local, as reported by IsLocal.
func Localize(path string) (string, error)Match reports whether name matches the shell file name pattern. The pattern syntax is: pattern: { term } term: '*' matches any sequence of non-Separator characters '?' matches any single non-Separator character '[' [ '^' ] { character-range } ']' character class (must be non-empty) c matches character c (c != '*', '?', '\\', '[') '\\' c matches character c character-range: c matches character c (c != '\\', '-', ']') '\\' c matches character c lo '-' hi matches character c for lo <= c <= hi Match requires pattern to match all of name, not just a substring. The only possible returned error is [ErrBadPattern], when pattern is malformed. On Windows, escaping is disabled. Instead, '\\' is treated as path separator.
func Match(pattern string, name string) (matched bool, err error)Rel returns a relative path that is lexically equivalent to targpath when joined to basepath with an intervening separator. That is, [Join](basepath, Rel(basepath, targpath)) is equivalent to targpath itself. On success, the returned path will always be relative to basepath, even if basepath and targpath share no elements. An error is returned if targpath can't be made relative to basepath or if knowing the current working directory would be necessary to compute it. Rel calls [Clean] on the result.
func Rel(basepath string, targpath string) (string, error)Split splits path immediately following the final [Separator], separating it into a directory and file name component. If there is no Separator in path, Split returns an empty dir and file set to path. The returned values have the property that path = dir+file.
func Split(path string) (dir string, file string)SplitList splits a list of paths joined by the OS-specific [ListSeparator], usually found in PATH or GOPATH environment variables. Unlike strings.Split, SplitList returns an empty slice when passed an empty string.
func SplitList(path string) []stringToSlash returns the result of replacing each separator character in path with a slash ('/') character. Multiple separators are replaced by multiple slashes.
func ToSlash(path string) stringVolumeName returns leading volume name. Given "C:\foo\bar" it returns "C:" on Windows. Given "\\host\share\foo" it returns "\\host\share". On other platforms it returns "".
func VolumeName(path string) stringWalk 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 [WalkFunc] documentation for details. The files are walked in lexical order, which makes the output deterministic but requires Walk to read an entire directory into memory before proceeding to walk that directory. Walk does not follow symbolic links. Walk is less efficient than [WalkDir], introduced in Go 1.16, which avoids calling os.Lstat on every visited file or directory.
func Walk(root string, fn WalkFunc) errorWalkDir 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. WalkDir calls fn with paths that use the separator character appropriate for the operating system. This is unlike [io/fs.WalkDir], which always uses slash separated paths.
func WalkDir(root string, fn fs.WalkDirFunc) errorfunc abs(path string) (string, error)func abs(path string) (string, error)func abs(path string) (string, error)baseIsDotDot reports whether the last element of path is "..". The given path should be 'Clean'-ed in advance.
func baseIsDotDot(path string) boolcleanGlobPath prepares path for glob matching.
func cleanGlobPath(path string) stringcleanGlobPathWindows is windows version of cleanGlobPath.
func cleanGlobPathWindows(path string) (prefixLen int, cleaned string)func evalSymlinks(path string) (string, error)func evalSymlinks(path string) (string, error)func evalSymlinks(path string) (string, error)getEsc gets a possibly-escaped character from chunk, for a character class.
func getEsc(chunk string) (r rune, nchunk string, err error)glob searches for files matching pattern in the directory dir and appends them to matches. If the directory cannot be opened, it returns the existing matches. New matches are added in lexicographical order.
func glob(dir string, pattern string, matches []string) (m []string, e error)func globWithLimit(pattern string, depth int) (matches []string, err error)hasMeta reports whether path contains any of the magic characters recognized by Match.
func hasMeta(path string) boolfunc join(elem []string) stringfunc join(elem []string) stringfunc join(elem []string) stringmatchChunk checks whether chunk matches the beginning of s. If so, it returns the remainder of s (after the match). Chunk is all single-character operators: literals, char classes, and ?.
func matchChunk(chunk string, s string) (rest string, ok bool, err error)normBase returns the last element of path with correct case.
func normBase(path string) (string, error)normVolumeName is like VolumeName, but makes drive letter upper case. result of EvalSymlinks must be unique, so we have EvalSymlinks(`c:\a`) == EvalSymlinks(`C:\a`).
func normVolumeName(path string) stringreadDirNames reads the directory named by dirname and returns a sorted list of directory entry names.
func readDirNames(dirname string) ([]string, error)func sameWord(a string, b string) boolfunc sameWord(a string, b string) boolfunc sameWord(a string, b string) boolscanChunk gets the next segment of pattern, which is a non-star string possibly preceded by a star.
func scanChunk(pattern string) (star bool, chunk string, rest string)func splitList(path string) []stringfunc splitList(path string) []stringfunc splitList(path string) []stringtoNorm returns the normalized path that is guaranteed to be unique. It should accept the following formats: - UNC paths (e.g \\server\share\foo\bar) - absolute paths (e.g C:\foo\bar) - relative paths begin with drive letter (e.g C:foo\bar, C:..\foo\bar, C:.., C:.) - relative paths begin with '\' (e.g \foo\bar) - relative paths begin without '\' (e.g foo\bar, ..\foo\bar, .., .) The returned normalized path will be in the same form (of 5 listed above) as the input path. If two paths A and B are indicating the same file with the same format, toNorm(A) should be equal to toNorm(B). The normBase parameter should be equal to the normBase func, except for in tests. See docs on the normBase func.
func toNorm(path string, normBase func(string) (string, error)) (string, error)func unixAbs(path string) (string, error)walk recursively descends path, calling walkFn.
func walk(path string, info fs.FileInfo, walkFn WalkFunc) errorwalkDir recursively descends path, calling walkDirFn.
func walkDir(path string, d fs.DirEntry, walkDirFn fs.WalkDirFunc) errorfunc walkSymlinks(path string) (string, error)Generated with Arrow