utils

Documentation

Index

• Variables
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func CheckExcludedPaths(path string) bool
• func ConfigSetup()
• func DatabaseSetup(d DatabaseInformation)
• func MustAsset(name string) []byte
• func PrettifyJSON(rawString string) string
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type ApplicationEnvironment
• type DatabaseInformation

Variables

var DB *sql.DB //nolint:gochecknoglobals

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets. nolint: deadcode

func CheckExcludedPaths

func CheckExcludedPaths(path string) bool

Check the wanted path is not in the do not log list.

func ConfigSetup

func ConfigSetup()

Initialize the configuration instance to the values described in the .env file.

func DatabaseSetup

func DatabaseSetup(d DatabaseInformation)

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables. nolint: deadcode

func PrettifyJSON

func PrettifyJSON(rawString string) string

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type ApplicationEnvironment

type ApplicationEnvironment struct {
	ApplicationID                     string
	ApplicationName                   string
	ApplicationTimezone               string
	GoScopeDatabaseConnection         string
	GoScopeDatabaseType               string
	GoScopeEntriesPerPage             int
	HasFrontendDisabled               bool
	GoScopeDatabaseMaxOpenConnections int
	GoScopeDatabaseMaxIdleConnections int
	GoScopeDatabaseMaxConnLifetime    int
}

Required application environment variables.

var Config ApplicationEnvironment //nolint:gochecknoglobals

Config is the global instance of the application's configuration.

type DatabaseInformation

type DatabaseInformation struct {
	Type                  string
	Connection            string
	MaxOpenConnections    int
	MaxIdleConnections    int
	MaxConnectionLifetime int
}