ospath

Documentation

Index

• Constants
• func KeepAbs(path string, rel func(string) string) string
• func MustDir(perm fs.FileMode, forfile string) (file string)
• func ProvideDir(perm fs.FileMode, forfile string) (file string, err error)
• type App
  • func NewApp(set AppPaths, app ...string) App
  • func (a App) Bin(rel ...string) string
  • func (a App) BinPath(rel string) string
  • func (a App) CheckDirs(flags AppPath) (res AppPath, err error)
  • func (a App) Doc(rel ...string) string
  • func (a App) DocPath(rel string) string
  • func (a App) Lib(rel ...string) string
  • func (a App) LibPath(rel string) string
  • func (a App) LocalData(rel ...string) string
  • func (a App) LocalDataPath(rel string) string
  • func (a App) ProvideDirs(perm fs.FileMode, flags AppPath) error
  • func (a App) RoamingData(rel ...string) string
  • func (a App) RoamingDataPath(rel string) string
• type AppPath
  • func (ap AppPath) All(flags AppPath) bool
  • func (ap AppPath) Any(flags AppPath) bool
• type AppPaths
• type DesktopUserApp
  • func NewDesktopUserApp(username string) DesktopUserApp
  • func (u DesktopUserApp) Bin(app ...string) string
  • func (u DesktopUserApp) Doc(app ...string) string
  • func (u DesktopUserApp) Lib(app ...string) string
  • func (u DesktopUserApp) LocalData(app ...string) string
  • func (u DesktopUserApp) RoamingData(app ...string) string
• type DirTree
  • func ExeDirTree(init *DirTree) *DirTree
  • func NewDirTree(basedir string, init *DirTree) *DirTree
  • func (d *DirTree) Bin(_ ...string) string
  • func (d *DirTree) Doc(_ ...string) string
  • func (d *DirTree) Lib(_ ...string) string
  • func (d *DirTree) LocalData(_ ...string) string
  • func (d *DirTree) RoamingData(_ ...string) string
• type SingleDir
  • func ExeDir() SingleDir
  • func (d SingleDir) Bin(_ ...string) string
  • func (d SingleDir) Doc(_ ...string) string
  • func (d SingleDir) Lib(_ ...string) string
  • func (d SingleDir) LocalData(_ ...string) string
  • func (d SingleDir) RoamingData(_ ...string) string

Examples

• DirTree
• SingleDir

Constants

const AllPaths = InstallPaths | DataPaths

const DataPaths = LocalDataPath | RoamingDataPath

const InstallPaths = BinPath | LibPath | DocPath

Functions

func KeepAbs

func KeepAbs(path string, rel func(string) string) string

func MustDir

func MustDir(perm fs.FileMode, forfile string) (file string)

func ProvideDir

func ProvideDir(perm fs.FileMode, forfile string) (file string, err error)

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func NewApp

func NewApp(set AppPaths, app ...string) App

func (App) Bin

func (a App) Bin(rel ...string) string

func (App) BinPath

func (a App) BinPath(rel string) string

func (App) CheckDirs

func (a App) CheckDirs(flags AppPath) (res AppPath, err error)

func (App) Doc

func (a App) Doc(rel ...string) string

func (App) DocPath

func (a App) DocPath(rel string) string

func (App) Lib

func (a App) Lib(rel ...string) string

func (App) LibPath

func (a App) LibPath(rel string) string

func (App) LocalData

func (a App) LocalData(rel ...string) string

func (App) LocalDataPath

func (a App) LocalDataPath(rel string) string

func (App) ProvideDirs

func (a App) ProvideDirs(perm fs.FileMode, flags AppPath) error

func (App) RoamingData

func (a App) RoamingData(rel ...string) string

func (App) RoamingDataPath

func (a App) RoamingDataPath(rel string) string

type AppPath

type AppPath int

const (
	BinPath AppPath = (1 << iota)
	LibPath
	DocPath
	LocalDataPath
	RoamingDataPath
)

func (AppPath) All

func (ap AppPath) All(flags AppPath) bool

func (AppPath) Any

func (ap AppPath) Any(flags AppPath) bool

type AppPaths

type AppPaths interface {
	Bin(app ...string) string
	Lib(app ...string) string
	Doc(app ...string) string
	LocalData(app ...string) string
	RoamingData(app ...string) string
}

type DesktopUserApp

type DesktopUserApp string

func NewDesktopUserApp

func NewDesktopUserApp(username string) DesktopUserApp

func (DesktopUserApp) Bin

func (u DesktopUserApp) Bin(app ...string) string

func (DesktopUserApp) Doc

func (u DesktopUserApp) Doc(app ...string) string

func (DesktopUserApp) Lib

func (u DesktopUserApp) Lib(app ...string) string

func (DesktopUserApp) LocalData

func (u DesktopUserApp) LocalData(app ...string) string

func (DesktopUserApp) RoamingData

func (u DesktopUserApp) RoamingData(app ...string) string

type DirTree

type DirTree struct {
	RelBin         string
	RelLib         string
	RelDoc         string
	RelLocalData   string
	RelRoamingData string
	// contains filtered or unexported fields
}

Example

Output:

basedir/executable
basedir/lib/sample.so
basedir/doc/README.md
basedir/data/local.data
basedir/roaming/roaming.data

func ExeDirTree

func ExeDirTree(init *DirTree) *DirTree

func NewDirTree

func NewDirTree(basedir string, init *DirTree) *DirTree

func (*DirTree) Bin

func (d *DirTree) Bin(_ ...string) string

func (*DirTree) Doc

func (d *DirTree) Doc(_ ...string) string

func (*DirTree) Lib

func (d *DirTree) Lib(_ ...string) string

func (*DirTree) LocalData

func (d *DirTree) LocalData(_ ...string) string

func (*DirTree) RoamingData

func (d *DirTree) RoamingData(_ ...string) string

type SingleDir

type SingleDir string

Example

Output:

basedir/executable
basedir/sample.so
basedir/README.md
basedir/local.data
basedir/roaming.data

func ExeDir

func ExeDir() SingleDir

func (SingleDir) Bin

func (d SingleDir) Bin(_ ...string) string

func (SingleDir) Doc

func (d SingleDir) Doc(_ ...string) string

func (SingleDir) Lib

func (d SingleDir) Lib(_ ...string) string

func (SingleDir) LocalData

func (d SingleDir) LocalData(_ ...string) string

func (SingleDir) RoamingData

func (d SingleDir) RoamingData(_ ...string) string