go1.20.5
GoThrough

filepath.ListSeparator

const ListSeparator = os.PathListSeparator

filepath.Separator

const Separator = os.PathSeparator

filepath.ErrBadPattern

// ErrBadPattern indicates a pattern was malformed. var ErrBadPattern = errors.New("syntax error in pattern")

filepath.SkipAll

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

filepath.SkipDir

// SkipDir is used as a return value from WalkFuncs 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 = fs.SkipDir

filepath.Abs

// Abs 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)

filepath.Base

// 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) string

filepath.Clean

// Clean 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 ".". // // 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) string

filepath.Dir

// Dir 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) string

filepath.EvalSymlinks

// EvalSymlinks 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)

filepath.Ext

// 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) string

filepath.FromSlash

// FromSlash returns the result of replacing each slash ('/') character // in path with a separator character. Multiple slashes are replaced // by multiple separators. func FromSlash(path string) string

filepath.Glob

// 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 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)

filepath.HasPrefix

// 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) bool

filepath.HasPrefix

// 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) bool

filepath.HasPrefix

// 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) bool

filepath.IsAbs

// IsAbs reports whether the path is absolute. func IsAbs(path string) bool

filepath.IsAbs

// IsAbs reports whether the path is absolute. func IsAbs(path string) bool

filepath.IsAbs

// IsAbs reports whether the path is absolute. func IsAbs(path string) (b bool)

filepath.IsLocal

// IsLocal 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) bool

filepath.Join

// Join 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) string

filepath.Match

// 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)

filepath.Rel

// 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)

filepath.Split

// 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)

filepath.SplitList

// 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) []string

filepath.ToSlash

// ToSlash 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) string

filepath.VolumeName

// VolumeName 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) string

filepath.Walk

// Walk 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) error

filepath.WalkDir

// 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. // // 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) error