osbridge

README

OS Bridge for Go

We have implemented this to allow us to differentiate between different operating systems: Mac, Win and Linux.

Currently there is actually no difference between operating systems in the code, but that will be changing as we evolve our integration with each operating system.

##LICENSE

• AGPL-3.0

Documentation

Index

• Constants
• Variables
• type Args
• type Dir
• type DirMap
• type Name
• type OsBridge
  • func NewOsBridge(args ...*Args) *OsBridge
  • func (me *OsBridge) GetAdminRootDir() Dir
  • func (me *OsBridge) GetCacheDir() Dir
  • func (me *OsBridge) GetNamedDir(dn Name) Url
  • func (me *OsBridge) GetNamedDirMap() DirMap
  • func (me *OsBridge) GetNamedPath(pn Name) Url
  • func (me *OsBridge) GetNamedPathMap() PathMap
  • func (me *OsBridge) GetProjectDir() string
  • func (me *OsBridge) GetProjectName() Name
  • func (me *OsBridge) GetSupportRequestUrl() Url
  • func (me *OsBridge) GetUserConfigDir() Dir
  • func (me *OsBridge) GetUserHomeDir() Dir
• type OsBridger
  • func Get(args ...*Args) OsBridger
• type Path
• type PathMap
• type Url

Constants

const (
	DefaultProjectName       Name = "OsBridge for Go"
	DefaultUserDataPath      Path = ".osbridge"
	DefaultAdminPath         Path = "admin"
	DefaultCachePath         Path = "cache"
	DefaultProjectDir        Dir  = "project"
	DefaultSupportRequestUrl Url  = "https://github.com/gearboxworks/go-status/issues"
)

Go-OsBridge - Operating System Bridge package for use in Go apps Copyright (C) 2019 NewClarity Consulting LLC

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

Variables

var NilOsBridge = (*OsBridge)(nil)

Types

type Args

type Args OsBridge

type Dir

type Dir = string

type DirMap

type DirMap = map[Name]Dir

type Name

type Name = string

type OsBridge

type OsBridge struct {
	ProjectName       Name
	ProjectDir        Dir
	UserDataPath      Path
	CachePath         Path
	AdminPath         Path
	SupportRequestUrl Url
	NamedPathMap      map[Name]Path
	NamedDirMap       map[Name]Dir
}

func NewOsBridge

func NewOsBridge(args ...*Args) *OsBridge

func (*OsBridge) GetAdminRootDir

func (me *OsBridge) GetAdminRootDir() Dir

func (*OsBridge) GetCacheDir

func (me *OsBridge) GetCacheDir() Dir

func (*OsBridge) GetNamedDir

func (me *OsBridge) GetNamedDir(dn Name) Url

func (*OsBridge) GetNamedDirMap

func (me *OsBridge) GetNamedDirMap() DirMap

func (*OsBridge) GetNamedPath

func (me *OsBridge) GetNamedPath(pn Name) Url

func (*OsBridge) GetNamedPathMap

func (me *OsBridge) GetNamedPathMap() PathMap

func (*OsBridge) GetProjectDir

func (me *OsBridge) GetProjectDir() string

func (*OsBridge) GetProjectName

func (me *OsBridge) GetProjectName() Name

func (*OsBridge) GetSupportRequestUrl

func (me *OsBridge) GetSupportRequestUrl() Url

func (*OsBridge) GetUserConfigDir

func (me *OsBridge) GetUserConfigDir() Dir

func (*OsBridge) GetUserHomeDir

func (me *OsBridge) GetUserHomeDir() Dir

type OsBridger

type OsBridger interface {
	GetUserHomeDir() Dir
	GetProjectName() Name
	GetProjectDir() Dir
	GetUserConfigDir() Dir
	GetAdminRootDir() Dir
	GetCacheDir() Dir
	GetSupportRequestUrl() Url
	GetNamedPath(pn Name) Url
	GetNamedDir(dn Name) Url
	GetNamedPathMap() PathMap
	GetNamedDirMap() DirMap
}

func Get

func Get(args ...*Args) OsBridger

type Path

type Path = string

type PathMap

type PathMap = map[Name]Path

type Url

type Url = string