version: 1.10

package filepath

import "path/filepath"

Overview

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.

Index

Examples

Package files

match.go path.go path_unix.go symlink.go symlink_unix.go

Constants

  1. const (
  2.     Separator     = os.PathSeparator
  3.     ListSeparator = os.PathListSeparator
  4. )

Variables

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

ErrBadPattern indicates a globbing pattern was malformed.

  1. var SkipDir = errors.New("skip this directory")

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.

func Abs

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

func Base

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

func Clean

  1. 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. 1. Replace multiple Separator elements with a single one.
  2. 2. Eliminate each . path name element (the current directory).
  3. 3. Eliminate each inner .. path name element (the parent directory)
  4.    along with the non-.. element that precedes it.
  5. 4. Eliminate .. elements that begin a rooted path:
  6.    that is, replace "/.." by "/" at the beginning of a path,
  7.    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 Dir

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

  1. func EvalSymlinks(path string) (string, error)

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 Ext

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


Example:

  1. fmt.Printf("No dots: %q\n", filepath.Ext("index"))
  2. fmt.Printf("One dot: %q\n", filepath.Ext("index.js"))
  3. fmt.Printf("Two dots: %q\n", filepath.Ext("main.test.js"))
  4. // Output:
  5. // No dots: ""
  6. // One dot: ".js"
  7. // Two dots: ".js"

func FromSlash

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

func Glob

  1. func Glob(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 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 HasPrefix

  1. func HasPrefix(p, 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.

func IsAbs

  1. func IsAbs(path string) bool

IsAbs reports whether the path is absolute.

func Join

  1. func Join(elem ...string) string

Join joins any number of path elements into a single path, adding a Separator if
necessary. Join calls Clean on the result; in particular, all empty strings are
ignored. On Windows, the result is a UNC path if and only if the first path
element is a UNC path.


Example:

  1. fmt.Println("On Unix:")
  2. fmt.Println(filepath.Join("a", "b", "c"))
  3. fmt.Println(filepath.Join("a", "b/c"))
  4. fmt.Println(filepath.Join("a/b", "c"))
  5. fmt.Println(filepath.Join("a/b", "/c"))
  6. // Output:
  7. // On Unix:
  8. // a/b/c
  9. // a/b/c
  10. // a/b/c
  11. // a/b/c

func Match

  1. func Match(pattern, name string) (matched bool, err error)

Match reports whether name matches the shell file name pattern. The pattern
syntax is:

  1. pattern:
  2.     { term }
  3. term:
  4.     '*'         matches any sequence of non-Separator characters
  5.     '?'         matches any single non-Separator character
  6.     '[' [ '^' ] { character-range } ']'
  7.                 character class (must be non-empty)
  8.     c           matches character c (c != '*', '?', '\\', '[')
  9.     '\\' c      matches character c
  11. character-range:
  12.     c           matches character c (c != '\\', '-', ']')
  13.     '\\' c      matches character c
  14.     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 Rel

  1. func Rel(basepath, 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. 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.


Example:

  1. paths := []string{
  2.     "/a/b/c",
  3.     "/b/c",
  4.     "./b/c",
  5. }
  6. base := "/a"
  8. fmt.Println("On Unix:")
  9. for _, p := range paths {
  10.     rel, err := filepath.Rel(base, p)
  11.     fmt.Printf("%q: %q %v\n", p, rel, err)
  12. }
  14. // Output:
  15. // On Unix:
  16. // "/a/b/c": "b/c" <nil>
  17. // "/b/c": "../b/c" <nil>
  18. // "./b/c": "" Rel: can't make ./b/c relative to /a

func Split

  1. func Split(path string) (dir, file 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.


Example:

  1. paths := []string{
  2.     "/home/arnie/amelia.jpg",
  3.     "/mnt/photos/",
  4.     "rabbit.jpg",
  5.     "/usr/local//go",
  6. }
  7. fmt.Println("On Unix:")
  8. for _, p := range paths {
  9.     dir, file := filepath.Split(p)
  10.     fmt.Printf("input: %q\n\tdir: %q\n\tfile: %q\n", p, dir, file)
  11. }
  12. // Output:
  13. // On Unix:
  14. // input: "/home/arnie/amelia.jpg"
  15. //     dir: "/home/arnie/"
  16. //     file: "amelia.jpg"
  17. // input: "/mnt/photos/"
  18. //     dir: "/mnt/photos/"
  19. //     file: ""
  20. // input: "rabbit.jpg"
  21. //     dir: ""
  22. //     file: "rabbit.jpg"
  23. // input: "/usr/local//go"
  24. //     dir: "/usr/local//"
  25. //     file: "go"

func SplitList

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


Example:

  1. fmt.Println("On Unix:", filepath.SplitList("/a/b/c:/usr/bin"))
  2. // Output:
  3. // On Unix: [/a/b/c /usr/bin]

func ToSlash

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

func VolumeName

  1. 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 “”.

func Walk

  1. func Walk(root string, walkFn WalkFunc) error

Walk walks the file tree rooted at root, calling walkFn for each file or
directory in the tree, including root. All errors that arise visiting files and
directories are filtered by walkFn. The files are walked in lexical order, which
makes the output deterministic but means that for very large directories Walk
can be inefficient. Walk does not follow symbolic links.


Example:

  1. dir := "dir/to/walk"
  2. subDirToSkip := "skip" // dir/to/walk/skip
  4. err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
  5.     if err != nil {
  6.         fmt.Printf("prevent panic by handling failure accessing a path %q: %v\n", dir, err)
  7.         return err
  8.     }
  9.     if info.IsDir() && info.Name() == subDirToSkip {
  10.         fmt.Printf("skipping a dir without errors: %+v \n", info.Name())
  11.         return filepath.SkipDir
  12.     }
  13.     fmt.Printf("visited file: %q\n", path)
  14.     return nil
  15. })
  17. if err != nil {
  18.     fmt.Printf("error walking the path %q: %v\n", dir, err)
  19. }

type WalkFunc

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

WalkFunc is the type of the function called for each file or directory visited
by Walk. The path argument contains the argument to Walk as a prefix; that is,
if Walk is called with “dir”, which is a directory containing the file “a”, the
walk function will be called with argument “dir/a”. The info argument is the
os.FileInfo for the named path.

If there was a problem walking to the file or directory named by path, the
incoming error will describe the problem and the function can decide how to
handle that error (and Walk will not descend into that directory). If an error
is returned, processing stops. The sole exception is when the function returns
the special value SkipDir. If the function returns SkipDir when invoked on a
directory, Walk skips the directory’s contents entirely. If the function returns
SkipDir when invoked on a non-directory file, Walk skips the remaining files in
the containing directory.