Namespace: go.std.path.filepath

v1.0

Contents

• Summary
• Index
• Constants
• Variables
• Functions, Macros, and Special Forms
• Types

Summary

Provides a low-level interface to the path/filepath package.

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

• *WalkFunc
• Abs
• Base
• Clean
• Dir
• ErrBadPattern
• EvalSymlinks
• Ext
• FromSlash
• Glob
• HasPrefix
• IsAbs
• Join
• ListSeparator
• Match
• Rel
• Separator
• SkipDir
• Split
• SplitList
• ToSlash
• VolumeName
• Walk
• WalkDir
• WalkFunc
• arrayOfWalkFunc

Legend

Constant Variable Function Macro Special form Type GoVar Receiver/Method

Constants

Constants are variables with :const true in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.

• ListSeparator

  Char v1.0

• Separator

  Char v1.0

Variables

• ErrBadPattern

  Var v1.0

  ErrBadPattern indicates a pattern was malformed.
  

• SkipDir

  Var v1.0

  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.
  

Functions, Macros, and Special Forms

• Abs

  Function v1.0

  (Abs path)
  

  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.
  
  Go input arguments: (path string)
  
  Go returns: (string, error)
  
  Joker input arguments: [^String path]
  
  Joker returns: [^String, ^Error]

• Base

  Function v1.0

  (Base path)
  

  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.
  
  Go input arguments: (path string)
  
  Go returns: string
  
  Joker input arguments: [^String path]
  
  Joker returns: ^String

• Clean

  Function v1.0

  (Clean path)
  

  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
  
  Go input arguments: (path string)
  
  Go returns: string
  
  Joker input arguments: [^String path]
  
  Joker returns: ^String

• Dir

  Function v1.0

  (Dir path)
  

  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.
  
  Go input arguments: (path string)
  
  Go returns: string
  
  Joker input arguments: [^String path]
  
  Joker returns: ^String

• EvalSymlinks

  Function v1.0

  (EvalSymlinks path)
  

  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.
  
  Go input arguments: (path string)
  
  Go returns: (string, error)
  
  Joker input arguments: [^String path]
  
  Joker returns: [^String, ^Error]

• Ext

  Function v1.0

  (Ext path)
  

  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.
  
  Go input arguments: (path string)
  
  Go returns: string
  
  Joker input arguments: [^String path]
  
  Joker returns: ^String

• FromSlash

  Function v1.0

  (FromSlash path)
  

  FromSlash returns the result of replacing each slash ('/') character
  in path with a separator character. Multiple slashes are replaced
  by multiple separators.
  
  Go input arguments: (path string)
  
  Go returns: string
  
  Joker input arguments: [^String path]
  
  Joker returns: ^String

• Glob

  Function v1.0

  (Glob pattern)
  

  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.
  
  Go input arguments: (pattern string)
  
  Go returns: (matches []string, err error)
  
  Joker input arguments: [^String pattern]
  
  Joker returns: [^arrayOfString matches, ^Error err]

• HasPrefix

  Function v1.0

  (HasPrefix p prefix)
  

  HasPrefix exists for historical compatibility and should not be used.
  
  Deprecated: HasPrefix does not respect path boundaries and
  does not ignore case when required.
  
  Go input arguments: (p string, prefix string)
  
  Go returns: bool
  
  Joker input arguments: [^String p, ^String prefix]
  
  Joker returns: ^Boolean

• IsAbs

  Function v1.0

  (IsAbs path)
  

  IsAbs reports whether the path is absolute.
  
  Go input arguments: (path string)
  
  Go returns: bool
  
  Joker input arguments: [^String path]
  
  Joker returns: ^Boolean

• Join

  Function v1.0

  (Join & elem)
  

  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.
  
  Go input arguments: (elem ...string)
  
  Go returns: string
  
  Joker input arguments: [& ^String elem]
  
  Joker returns: ^String

• Match

  Function v1.0

  (Match pattern name)
  

  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.
  
  Go input arguments: (pattern string, name string)
  
  Go returns: (matched bool, err error)
  
  Joker input arguments: [^String pattern, ^String name]
  
  Joker returns: [^Boolean matched, ^Error err]

• Rel

  Function v1.0

  (Rel basepath targpath)
  

  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.
  
  Go input arguments: (basepath string, targpath string)
  
  Go returns: (string, error)
  
  Joker input arguments: [^String basepath, ^String targpath]
  
  Joker returns: [^String, ^Error]

• Split

  Function v1.0

  (Split path)
  

  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.
  
  Go input arguments: (path string)
  
  Go returns: (dir string, file string)
  
  Joker input arguments: [^String path]
  
  Joker returns: [^String dir, ^String file]

• SplitList

  Function v1.0

  (SplitList path)
  

  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.
  
  Go input arguments: (path string)
  
  Go returns: []string
  
  Joker input arguments: [^String path]
  
  Joker returns: ^arrayOfString

• ToSlash

  Function v1.0

  (ToSlash path)
  

  ToSlash returns the result of replacing each separator character
  in path with a slash ('/') character. Multiple separators are
  replaced by multiple slashes.
  
  Go input arguments: (path string)
  
  Go returns: string
  
  Joker input arguments: [^String path]
  
  Joker returns: ^String

• VolumeName

  Function v1.0

  (VolumeName path)
  

  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 "".
  
  Go input arguments: (path string)
  
  Go returns: string
  
  Joker input arguments: [^String path]
  
  Joker returns: ^String

• Walk

  Function v1.0

  (Walk root fn)
  

  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.
  
  Go input arguments: (root string, fn WalkFunc)
  
  Go returns: error
  
  Joker input arguments: [^String root, ^WalkFunc fn]
  
  Joker returns: ^Error

• WalkDir

  Function v1.0

  (WalkDir root fn)
  

  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.
  
  Go input arguments: (root string, fn io/fs.WalkDirFunc)
  
  Go returns: error
  
  Joker input arguments: [^String root, ^go.std.io.fs/WalkDirFunc fn]
  
  Joker returns: ^Error

Types

• *WalkFunc

  Concrete Type v1.0

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

• WalkFunc

  Concrete Type v1.0

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

• arrayOfWalkFunc

  Concrete Type v1.0

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