pos

Documentation

Overview

Package parlos provides simplified functions related to the os package

Package parlos provides simplified functions related to the os package

Package parlos provides simplified functions related to the os package

Index

• Constants
• func AppDir(appName string) (directory string)
• func ExecDir() (dir string)
• func Exit(code int, err error)
• func Exit0()
• func Exit1(err error)
• func Exit1OneLine(err error)
• func HomeDir(relPaths string) (dir string)
• func OsExit(code int)
• func ParentDir() (dir string)
• func ShortHostname() (host string)
• func UserHomeDir() (homeDir string)
• type AppDirectory
  • func NewAppDir(appName string) (appd *AppDirectory)
  • func (appd *AppDirectory) Directory() (directory string)

Constants

const (
	StatusCodeErr   = 1
	StatusCodeUsage = 2
)

Functions

func AppDir

func AppDir(appName string) (directory string)

AppDir gets an app-specific file system directory

func ExecDir

func ExecDir() (dir string)

ExecDir gets abolute path to directory where executable is located

func Exit

func Exit(code int, err error)

Exit terminate the command echoing to stderr returning status code

func Exit0

func Exit0()

Exit0 terminates the process successfully

func Exit1

func Exit1(err error)

Exit1 terminate the command echoing a failure to stderr and returning status code 1

func Exit1OneLine

func Exit1OneLine(err error)

Exit1OneLine terminate the command echoing to stderr returning status code 1

func HomeDir

func HomeDir(relPaths string) (dir string)

HomeDir creates levels of directories in users’s home. if directories do not exist, they are created with permissions u=rwx. This should never fail, when it does, panic is thrown

func OsExit

func OsExit(code int)

OsExit does os.Exit

func ParentDir

func ParentDir() (dir string)

ParentDir gets absolute path of executable parent directory

func ShortHostname

func ShortHostname() (host string)

ShortHostname gets hostname without domain part This should never fail, when it does, panic is thrown

func UserHomeDir

func UserHomeDir() (homeDir string)

UserHomeDir obtains the absolute path to the process owning user’s home directory. This should never fail, when it does, panic is thrown

Types

type AppDirectory

type AppDirectory struct {
	App string
}

func NewAppDir

func NewAppDir(appName string) (appd *AppDirectory)

NewAppDir returns an object providing an app-specific file system location with defered directory creation

func (*AppDirectory) Directory

func (appd *AppDirectory) Directory() (directory string)