Namespace: go.std.path

v1.0

Contents

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

Summary

Provides a low-level interface to the path package.

Package path implements utility routines for manipulating slash-separated
paths.

The path package should only be used for paths separated by forward
slashes, such as the paths in URLs. This package does not deal with
Windows paths with drive letters or backslashes; to manipulate
operating system paths, use the path/filepath package.

Index

• Base
• Clean
• Dir
• ErrBadPattern
• Ext
• IsAbs
• Join
• Match
• Split

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.

(None.)

Variables

• ErrBadPattern

  Var v1.0

  ErrBadPattern indicates a pattern was malformed.
  

Functions, Macros, and Special Forms

• Base

  Function v1.0

  (Base path)
  

  Base returns the last element of path.
  Trailing slashes are removed before extracting the last element.
  If the path is empty, Base returns ".".
  If the path consists entirely of slashes, Base returns "/".
  
  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 slashes with a single slash.
  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.
  
  The returned path ends in a slash only if it is the root "/".
  
  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 using Split, the path is Cleaned and trailing
  slashes are removed.
  If the path is empty, Dir returns ".".
  If the path consists entirely of slashes followed by non-slash bytes, Dir
  returns a single slash. In any other case, the returned path does not end in a
  slash.
  
  Go input arguments: (path string)
  
  Go returns: string
  
  Joker input arguments: [^String path]
  
  Joker returns: ^String

• 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 slash-separated 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

• 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 slashes. 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.
  
  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 pattern.
  The pattern syntax is:
  
  pattern:
  { term }
  term:
  '*' matches any sequence of non-/ characters
  '?' matches any single non-/ 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.
  
  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]

• Split

  Function v1.0

  (Split path)
  

  Split splits path immediately following the final slash,
  separating it into a directory and file name component.
  If there is no slash 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]

Types

(None.)