All packages

path/filepath

import "path/filepath"

Package filepath implements utility routines for manipulating filename paths in a way compatible with the target operating system-defined file paths. The filepath package uses either forward slashes or backslashes, depending on the operating system. To process paths such as URLs that always use forward slashes regardless of the operating system, see the [path] package.

Go 1.26.1

Constants

const (
	Separator     = os.PathSeparator
	ListSeparator = os.PathListSeparator
)

path/filepath/path.go:25

const (
	Separator     = os.PathSeparator
	ListSeparator = os.PathListSeparator
)

path/filepath/path.go:24

Variables

var ErrBadPattern = errors.New("syntax error in pattern")

ErrBadPattern indicates a pattern was malformed.

path/filepath/match.go:18

var SkipAll error = fs.SkipAll

SkipAll 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.

path/filepath/path.go:265

var SkipDir error = fs.SkipDir

SkipDir 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.

path/filepath/path.go:260

Functions

func Abs(path string) (string, error)

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.

path/filepath/path.go:161

func Base(path string) string

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.

path/filepath/path.go:456

func Clean(path string) string

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 "/.." b...

path/filepath/path.go:55

func Dir(path string) string

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.

path/filepath/path.go:466

func Ext(path string) string

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.

path/filepath/path.go:138

func FromSlash(path string) string

FromSlash 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.

path/filepath/path.go:102

func Glob(pattern string) ([]string, 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 [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.

path/filepath/match.go:231

func HasPrefix(p string, prefix string) bool

HasPrefix exists for historical compatibility and should not be used. Deprecated: HasPrefix does not respect path boundaries and does not ignore case when required.

path/filepath/path_unix.go:17

func IsAbs(path string) bool

IsAbs reports whether the path is absolute.

path/filepath/path.go:152

func IsLocal(path string) bool

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 partic...

path/filepath/path.go:73

func Join(elem ...string) string

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.

path/filepath/path.go:130

func Localize(path string) (string, error)

Localize 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.

path/filepath/path.go:85

func Match(pattern string, name string) (bool, 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 (except on Windows) character-range: c matches character c (c !=...

path/filepath/match.go:46

func Rel(basePath string, targPath string) (string, 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. The returned path will always be relative to basePath, even if basePath and targPath share no elements. Rel calls [Clean] on the result. 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.

path/filepath/path.go:185

func Split(path string) string

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.

path/filepath/path.go:119

func SplitList(path string) []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.

path/filepath/path.go:110

func ToSlash(path string) string

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

path/filepath/path.go:92

func VolumeName(path string) string

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 "".

path/filepath/path.go:474

func Walk(root string, fn WalkFunc) error

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 ...

path/filepath/path.go:423

func WalkDir(root string, fn fs.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. WalkDir calls fn with paths that use t...

path/filepath/path.go:396

Types

type WalkFunc func(path string, info fs.FileInfo, err error) error

WalkFunc 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 funct...

path/filepath/path.go:305