Documentation
¶
Overview ¶
Package doublestar is adapted from https://github.com/bmatcuk/doublestar Copyright Bob Matcuk. All Rights Reserved. SPDX-License-Identifier: MIT
Package doublestar is adapted from https://github.com/bmatcuk/doublestar Copyright Bob Matcuk. All Rights Reserved. SPDX-License-Identifier: MIT
Package doublestar is adapted from https://github.com/bmatcuk/doublestar Copyright Bob Matcuk. All Rights Reserved. SPDX-License-Identifier: MIT
Package doublestar is adapted from https://github.com/bmatcuk/doublestar Copyright Bob Matcuk. All Rights Reserved. SPDX-License-Identifier: MIT
Package doublestar is adapted from https://github.com/bmatcuk/doublestar Copyright Bob Matcuk. All Rights Reserved. SPDX-License-Identifier: MIT
Package doublestar is adapted from https://github.com/bmatcuk/doublestar Copyright Bob Matcuk. All Rights Reserved. SPDX-License-Identifier: MIT
Index ¶
- Variables
- func Glob(fsys fs.FS, pattern string) ([]string, error)
- func GlobWalk(fsys fs.FS, pattern string, fn GlobWalkFunc) error
- func Match(pattern, name string) (bool, error)
- func PathMatch(pattern, name string) (bool, error)
- func SplitPattern(p string) (string, string)
- func ValidatePathPattern(s string) bool
- func ValidatePattern(s string) bool
- type GlobWalkFunc
Constants ¶
This section is empty.
Variables ¶
var ErrBadPattern = path.ErrBadPattern
ErrBadPattern indicates a pattern was malformed.
Functions ¶
func Glob ¶
Glob returns the names of all files matching pattern or nil if there is no matching file. The syntax of pattern is the same as in Match(). The pattern may describe hierarchical names such as usr/*/bin/ed.
Glob ignores file system errors such as I/O errors reading directories. The only possible returned error is ErrBadPattern, reporting that the pattern is malformed.
Note: this is meant as a drop-in replacement for io/fs.Glob(). Like io/fs.Glob(), this function assumes that your pattern uses `/` as the path separator even if that's not correct for your OS (like Windows). If you aren't sure if that's the case, you can use filepath.ToSlash() on your pattern before calling Glob().
Like `io/fs.Glob()`, patterns containing `/./`, `/../`, or starting with `/` will return no results and no errors. You can use SplitPattern to divide a pattern into a base path (to initialize an `FS` object) and pattern.
func GlobWalk ¶
func GlobWalk(fsys fs.FS, pattern string, fn GlobWalkFunc) error
GlobWalk calls the callback function `fn` for every file matching pattern. The syntax of pattern is the same as in Match() and the behavior is the same as Glob(), with regard to limitations (such as patterns containing `/./`, `/../`, or starting with `/`). The pattern may describe hierarchical names such as usr/*/bin/ed.
GlobWalk may have a small performance benefit over Glob if you do not need a slice of matches because it can avoid allocating memory for the matches. Additionally, GlobWalk gives you access to the `fs.DirEntry` objects for each match, and lets you quit early by returning a non-nil error from your callback function.
GlobWalk ignores file system errors such as I/O errors reading directories. GlobWalk may return ErrBadPattern, reporting that the pattern is malformed. Additionally, if the callback function `fn` returns an error, GlobWalk will exit immediately and return that error.
Like Glob(), this function assumes that your pattern uses `/` as the path separator even if that's not correct for your OS (like Windows). If you aren't sure if that's the case, you can use filepath.ToSlash() on your pattern before calling GlobWalk().
func Match ¶
Match reports whether name matches the shell pattern. The pattern syntax is:
pattern:
{ term }
term:
'*' matches any sequence of non-path-separators
'/**/' matches zero or more directories
'?' matches any single non-path-separator character
'[' [ '^' '!' ] { character-range } ']'
character class (must be non-empty)
starting with `^` or `!` negates the class
'{' { term } [ ',' { term } ... ] '}'
alternatives
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 returns true if `name` matches the file name `pattern`. `name` and `pattern` are split on forward slash (`/`) characters and may be relative or absolute.
Match requires pattern to match all of name, not just a substring. The only possible returned error is ErrBadPattern, when pattern is malformed.
A doublestar (`**`) should appear surrounded by path separators such as `/**/`. A mid-pattern doublestar (`**`) behaves like bash's globstar option: a pattern such as `path/to/**.txt` would return the same results as `path/to/*.txt`. The pattern you're looking for is `path/to/**/*.txt`.
Note: this is meant as a drop-in replacement for path.Match() which always uses '/' as the path separator. If you want to support systems which use a different path separator (such as Windows), what you want is PathMatch(). Alternatively, you can run filepath.ToSlash() on both pattern and name and then use this function.
func PathMatch ¶
PathMatch returns true if `name` matches the file name `pattern`. The difference between Match and PathMatch is that PathMatch will automatically use your system's path separator to split `name` and `pattern`. On systems where the path separator is `'\'`, escaping will be disabled.
Note: this is meant as a drop-in replacement for filepath.Match(). It assumes that both `pattern` and `name` are using the system's path separator. If you can't be sure of that, use filepath.ToSlash() on both `pattern` and `name`, and then use the Match() function instead.
func SplitPattern ¶
SplitPattern is a utility function. Given a pattern, SplitPattern will return two strings: the first string is everything up to the last slash (`/`) that appears _before_ any unescaped "meta" characters (ie, `*?[{`). The second string is everything after that slash. For example, given the pattern:
../../path/to/meta*/**
^----------- split here
SplitPattern returns "../../path/to" and "meta*/**". This is useful for initializing os.DirFS() to call Glob() because Glob() will silently fail if your pattern includes `/./` or `/../`. For example:
base, pattern := SplitPattern("../../path/to/meta*/**")
fsys := os.DirFS(base)
matches, err := Glob(fsys, pattern)
If SplitPattern cannot find somewhere to split the pattern (for example, `meta*/**`), it will return "." and the unaltered pattern (`meta*/**` in this example).
Of course, it is your responsibility to decide if the returned base path is "safe" in the context of your application. Perhaps you could use Match() to validate against a list of approved base directories?
func ValidatePathPattern ¶
ValidatePathPattern only uses your OS path separator. In other words, use ValidatePattern if you would normally use Match() or Glob(). Use ValidatePathPattern if you would normally use PathMatch(). Keep in mind, Glob() requires '/' separators, even if your OS uses something else.
func ValidatePattern ¶
ValidatePattern validates a pattern. Patterns are validated while they run in Match(), PathMatch(), and Glob(), so, you normally wouldn't need to call this. However, there are cases where this might be useful: for example, if your program allows a user to enter a pattern that you'll run at a later time, you might want to validate it.
ValidatePattern assumes your pattern uses '/' as the path separator.
Source Files