pathutil

Documentation

Index

• func Create(name string, paths []string) (string, error)
• func Exists(path string) bool
• func ExpandHome(path, home string) string
• func Search(name string, paths []string) (string, error)
• func Unique(paths []string, home string) []string

Functions

func Create

func Create(name string, paths []string) (string, error)

Create returns a suitable location relative to which the file with the specified `name` can be written. The first path from the provided `paths` slice which is successfully created (or already exists) is used as a base path for the file. The `name` parameter should contain the name of the file which is going to be written in the location returned by this function, but it can also contain a set of parent directories, which will be created relative to the selected parent path.

func Exists

func Exists(path string) bool

Exists returns true if the specified path exists.

func ExpandHome

func ExpandHome(path, home string) string

ExpandHome substitutes `~` and `$HOME` at the start of the specified `path` using the provided `home` location.

func Search

func Search(name string, paths []string) (string, error)

Search searches for the file with the specified `name` in the provided slice of `paths`. The `name` parameter must contain the name of the file, but it can also contain a set of parent directories.

func Unique

func Unique(paths []string, home string) []string

Unique eliminates the duplicate paths from the provided slice and returns the result. The items in the output slice are in the order in which they occur in the input slice. If a `home` location is provided, the paths are expanded using the `ExpandHome` function.