files

Documentation

Index

• Constants
• func DirExists(path string) bool
• func EnsureDirExists(path string) error
• func Exists(path string) bool
• func FileExists(path string) bool
• func LoadJSON(fn string, out interface{}) error
• func SaveJSON(path string, data interface{}) error
• func WriteFile(path string, data []byte) error
• type Closer
  • func NewCloser(files ...*os.File) *Closer
  • func (c *Closer) AddFile(f *os.File) *Closer
  • func (c *Closer) Close(t bool)
  • func (c *Closer) SetLogger(l *log.Logger)
• type INI
  • func LoadINI(filename string) (*INI, error)
  • func NewINI() *INI
  • func (ini *INI) AddSection(name string) *INISection
  • func (ini *INI) Save(filename string, tabbed bool) error
• type INIField
  • func (f *INIField) GetBool(key string) bool
  • func (f *INIField) GetFloat(key string) float64
  • func (f *INIField) GetInt(key string) int
  • func (f *INIField) SetBool(key string, value bool)
  • func (f *INIField) SetFloat(key string, value float64)
  • func (f *INIField) SetInt(key string, value int)
  • func (f *INIField) SetString(key, value string)
• type INISection
  • func (s *INISection) AddBool(key string, value bool)
  • func (s *INISection) AddFloat(key string, value float64)
  • func (s *INISection) AddInt(key string, value int)
  • func (s *INISection) AddString(key string, value string)
  • func (s *INISection) GetBool(key string, alt bool) bool
  • func (s *INISection) GetFloat(key string, alt float64) float64
  • func (s *INISection) GetInt(key string, alt int) int
  • func (s *INISection) GetString(key, alt string) string

Constants

const (
	// INIBool type
	INIBool = iota
	// INIInt type
	INIInt
	// INIFloat type
	INIFloat
	// INIString type
	INIString
)

Functions

func DirExists

func DirExists(path string) bool

DirExists checks for the existence of a directory. It will return false if a file with that name exists.

func EnsureDirExists

func EnsureDirExists(path string) error

EnsureDirExists by creating it.

func Exists

func Exists(path string) bool

Exists checks for the existence of a file or directory.

func FileExists

func FileExists(path string) bool

FileExists checks for the existence of a file. It will return false if a directory with that name exists.

func LoadJSON

func LoadJSON(fn string, out interface{}) error

LoadJSON and unmarshal structure.

func SaveJSON

func SaveJSON(path string, data interface{}) error

SaveJSON after marshalling neatly.

func WriteFile

func WriteFile(path string, data []byte) error

WriteFile saves a file with private permissions.

Types

type Closer

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

Closer holds open files to close them all in sequence, logging any errors.

func NewCloser

func NewCloser(files ...*os.File) *Closer

NewCloser returns a pointer to a closer.

func (*Closer) AddFile

func (c *Closer) AddFile(f *os.File) *Closer

AddFile adds a file pointer to the closer's list.

func (*Closer) Close

func (c *Closer) Close(t bool)

Close and remove all files in the list, and log any errors from the Close() call with or without a timestamp.

func (*Closer) SetLogger

func (c *Closer) SetLogger(l *log.Logger)

SetLogger to an alternative logger.

type INI

type INI struct {
	// Sections with settings.
	Sections map[string]*INISection
	// Order sections were loaded or added in.
	Order []string
}

INI file base structure.

func LoadINI

func LoadINI(filename string) (*INI, error)

LoadINI from file and take a guess at the types of each value.

func NewINI

func NewINI() *INI

NewINI returns an empty INI structure.

func (*INI) AddSection

func (ini *INI) AddSection(name string) *INISection

AddSection to INI structure.

func (*INI) Save

func (ini *INI) Save(filename string, tabbed bool) error

Save outputs the INI to a file. If tabbed is true, the fields will be saved with a tab character prepended.

type INIField

type INIField struct {
	// Value will be stripped of surrounding whitespace when loaded.
	Value string
	// Type lets the user choose which Get* method to use when loading unknown files.
	Type byte
	// contains filtered or unexported fields
}

INIField contains a variable and its data.

func (*INIField) GetBool

func (f *INIField) GetBool(key string) bool

GetBool returns a field as a bool.

func (*INIField) GetFloat

func (f *INIField) GetFloat(key string) float64

GetFloat returns a field as a float64.

func (*INIField) GetInt

func (f *INIField) GetInt(key string) int

GetInt returns a field as an int.

func (*INIField) SetBool

func (f *INIField) SetBool(key string, value bool)

SetBool sets a field to a bool.

func (*INIField) SetFloat

func (f *INIField) SetFloat(key string, value float64)

SetFloat sets a field to a float64.

func (*INIField) SetInt

func (f *INIField) SetInt(key string, value int)

SetInt sets a field as an int.

func (*INIField) SetString

func (f *INIField) SetString(key, value string)

SetString sets a field as a string.

type INISection

type INISection struct {
	Fields map[string]*INIField
	// Order fields were loaded or added in.
	Order []string
}

INISection holds one or more fields.

func (*INISection) AddBool

func (s *INISection) AddBool(key string, value bool)

AddBool adds a new bool field to the section.

func (*INISection) AddFloat

func (s *INISection) AddFloat(key string, value float64)

AddFloat adds a new float64 field to the section.

func (*INISection) AddInt

func (s *INISection) AddInt(key string, value int)

AddInt adds a new int field to the section.

func (*INISection) AddString

func (s *INISection) AddString(key string, value string)

AddString adds a new string field to the section.

func (*INISection) GetBool

func (s *INISection) GetBool(key string, alt bool) bool

GetBool returns a field as a bool, or the alternative.

func (*INISection) GetFloat

func (s *INISection) GetFloat(key string, alt float64) float64

GetFloat returns a field as a float64, or the alternative.

func (*INISection) GetInt

func (s *INISection) GetInt(key string, alt int) int

GetInt returns a field as an int, or the alternative.

func (*INISection) GetString

func (s *INISection) GetString(key, alt string) string

GetString returns a field as a string, or the alternative.