util

Documentation

Index

• func CloseAll(closers ...io.Closer) error
• func CreateRootTempDir() error
• func DirEmpty(path string) bool
• func DirExists(path string) bool
• func ExitCode(err error) int
• func FileExists(path string) bool
• func ForEachLine(path string, fn func(line string) bool) error
• func ForEachReaderLine(r io.Reader, fn func(line string) bool) error
• func GenericGet(m map[string]interface{}, path string) interface{}
• func GenericSet(mp *map[string]interface{}, path string, value interface{})
• func GetRootTempDir() string
• func GetTempDirPath() (string, error)
• func GetTempFilePath(filename string) (string, error)
• func Git(arg ...string) (string, error)
• func Must(err error)
• func MustReadJSONFile(filename string) *jnode.Node
• func PropagateCloseError(closer io.Closer, f func() error) (err error)
• func ReadJSONFile(filename string) (*jnode.Node, error)
• func RemoveJNodeElementsIf(n *jnode.Node, f func(*jnode.Node) bool) *jnode.Node
• func RemoveJNodeEntriesIf(n *jnode.Node, f func(key string, value *jnode.Node) bool) *jnode.Node
• func RemoveRootTempDir() string
• func Size(n uint64) string
• func StringSliceContains(s []string, t string) bool
• func TempFile(pattern string) (string, error)
• func TruncateRight(s string, m int) string
• type AtomicFileWriter
  • func NewAtomicFileWriter(path string) (*AtomicFileWriter, error)
  • func (a *AtomicFileWriter) Close() error
  • func (a *AtomicFileWriter) Rename() error
  • func (a *AtomicFileWriter) Write(p []byte) (int, error)
• type Cache
  • func NewCache(max int) *Cache
  • func (c *Cache) Contains(key string) bool
  • func (c *Cache) Get(key string, fill func(string) interface{}) interface{}
  • func (c *Cache) Put(key string, v interface{})
• type StringSet
  • func NewStringSet() *StringSet
  • func NewStringSetWithValues(values []string) *StringSet
  • func (ss *StringSet) Add(s string) bool
  • func (ss *StringSet) AddAll(values ...string) *StringSet
  • func (ss *StringSet) Contains(s string) bool
  • func (ss *StringSet) Get(i int) string
  • func (ss *StringSet) Len() int
  • func (ss *StringSet) MarshalJSON() ([]byte, error)
  • func (ss *StringSet) Reset()
  • func (ss *StringSet) Values() []string

Functions

func CloseAll

func CloseAll(closers ...io.Closer) error

CloseAll calls Close() on every closer, returning the err from the first one that returns a non-nil error.

func CreateRootTempDir

func CreateRootTempDir() error

CreateRootTempDir - call only once from root command

func DirEmpty

func DirEmpty(path string) bool

func DirExists

func DirExists(path string) bool

func ExitCode

func ExitCode(err error) int

Returns the exit code from an error if the error is an exec.ExitError, or -1 if the err is non-nil, or 0 otherwise.

func FileExists

func FileExists(path string) bool

func ForEachLine

func ForEachLine(path string, fn func(line string) bool) error

func ForEachReaderLine

func ForEachReaderLine(r io.Reader, fn func(line string) bool) error

func GenericGet

func GenericGet(m map[string]interface{}, path string) interface{}

func GenericSet

func GenericSet(mp *map[string]interface{}, path string, value interface{})

func GetRootTempDir

func GetRootTempDir() string

GetRootTempDir - return the absolute path to the root temp dir

func GetTempDirPath

func GetTempDirPath() (string, error)

GetTempDirPath - return a unique absolute path for a dir

func GetTempFilePath

func GetTempFilePath(filename string) (string, error)

GetTempFilePath - return a unique absolute path for a file with filename

func Git

func Git(arg ...string) (string, error)

func Must

func Must(err error)

Must panics if err is non-nil

func MustReadJSONFile

func MustReadJSONFile(filename string) *jnode.Node

func PropagateCloseError

func PropagateCloseError(closer io.Closer, f func() error) (err error)

PropagateCloseError calls f then calls closer.Close(), returning the error from Close() if f did not return an error. Errors from Close() when writing can return important errors that should not be thrown away.

func ReadJSONFile

func ReadJSONFile(filename string) (*jnode.Node, error)

func RemoveJNodeElementsIf

func RemoveJNodeElementsIf(n *jnode.Node, f func(*jnode.Node) bool) *jnode.Node

func RemoveJNodeEntriesIf

func RemoveJNodeEntriesIf(n *jnode.Node, f func(key string, value *jnode.Node) bool) *jnode.Node

func RemoveRootTempDir

func RemoveRootTempDir() string

RemoveRootTempDir - remove the root tmp dir and all subdirs and files, should be called on exit

func Size

func Size(n uint64) string

func StringSliceContains

func StringSliceContains(s []string, t string) bool

func TempFile

func TempFile(pattern string) (string, error)

func TruncateRight

func TruncateRight(s string, m int) string

Replaces newlines in s with spaces and truncates with "..." if the len(s) is more than m. The resulting string will always be m characters or less.

Types

type AtomicFileWriter

type AtomicFileWriter struct {
	Temp *os.File
	// contains filtered or unexported fields
}

func NewAtomicFileWriter

func NewAtomicFileWriter(path string) (*AtomicFileWriter, error)

Creates a file writer that writes to a temporary file and can rename it to a target file when done. The temp file is created in the same directory as the target file; the rename operation should be atmoic in this case.

func (*AtomicFileWriter) Close

func (a *AtomicFileWriter) Close() error

Closes and deletes the tempfile unless it has already been renamed.

func (*AtomicFileWriter) Rename

func (a *AtomicFileWriter) Rename() error

Closes and renames the temp file.

func (*AtomicFileWriter) Write

func (a *AtomicFileWriter) Write(p []byte) (int, error)

type Cache

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

A simple-minded not-scalable LFU cache.

func NewCache

func NewCache(max int) *Cache

func (*Cache) Contains

func (c *Cache) Contains(key string) bool

func (*Cache) Get

func (c *Cache) Get(key string, fill func(string) interface{}) interface{}

func (*Cache) Put

func (c *Cache) Put(key string, v interface{})

type StringSet

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

func NewStringSet

func NewStringSet() *StringSet

func NewStringSetWithValues

func NewStringSetWithValues(values []string) *StringSet

func (*StringSet) Add

func (ss *StringSet) Add(s string) bool

Adds s to the set and returns true if the string wasn't already present

func (*StringSet) AddAll

func (ss *StringSet) AddAll(values ...string) *StringSet

func (*StringSet) Contains

func (ss *StringSet) Contains(s string) bool

func (*StringSet) Get

func (ss *StringSet) Get(i int) string

func (*StringSet) Len

func (ss *StringSet) Len() int

func (*StringSet) MarshalJSON

func (ss *StringSet) MarshalJSON() ([]byte, error)

func (*StringSet) Reset

func (ss *StringSet) Reset()

func (*StringSet) Values

func (ss *StringSet) Values() []string