README
¶
core/paths
The path helpers AutoDoc's core packages share, written once. Paths are slash-separated and clean, relative to a workspace or absolute.
| Function | Answers |
|---|---|
Under(p, dir) |
whether p is dir or inside it, by whole segments; every relative path is under "." |
ExpandHome(p) |
p with a leading ~ or ~/ made the home directory (ErrNoHome when there is none); any other path as it is. Used by the config's paths and a workspace's root |
Functions with no disk I/O, safe for concurrent use (ExpandHome reads the home directory from
the environment). An SQL form of Under (a dao.Predicate)
lives with the queries that need it, in core/index and core/pgstore.
Documentation
¶
Overview ¶
Package paths is the path helpers AutoDoc's core packages share, so each is written once. Paths are slash-separated and clean: a workspace's relative paths, or absolute ones.
Concurrency: the package is functions of their arguments (ExpandHome also reads the home directory from the environment); any number of goroutines may call them.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrNoHome = errs.Sentinel(errs.ErrInvalidArgument, "paths: no home directory")
ErrNoHome is a "~" path expanded with no home directory to put in its place.
Functions ¶
func ExpandHome ¶
ExpandHome is p with a leading "~" or "~/" made the user's home directory. Any other path is returned as it is.
Types ¶
This section is empty.
Source Files