file

Documentation

Index

• Constants
• Variables
• func New() interface{ ... }
• type Configuration
  • func (c *Configuration) Default()
  • func (c *Configuration) FromEnv(envs map[string]string)
  • func (c *Configuration) Validate() (err error)
• type File

Constants

const (
	FileEmpty     string = "file is empty"
	LockFileEmpty string = "lock file is empty"
)

const (
	EnvNameFile        string = "BLUDGEON_META_FILE"
	EnvNameLockFile    string = "BLUDGEON_META_LOCK_FILE"
	EnvNameFileLocking string = "BLUDGEON_META_FILE_LOCKING"
)

const (
	DefaultFile        string = "./data/bludgeon.json"
	DefaultLockFile    string = "./data/bludgeon.lock"
	DefaultFileLocking bool   = false
)

Variables

var (
	ErrFileEmpty     = errors.New(FileEmpty)
	ErrLockFileEmpty = errors.New(LockFileEmpty)
)

Functions

func New

func New() interface {
	File
	internal.Configurer
	internal.Initializer
	internal.Parameterizer
}

Types

type Configuration

type Configuration struct {
	File        string `json:"file"`
	FileLocking bool   `json:"file_locking"`
	LockFile    string `json:"lock_file"`
}

func (*Configuration) Default

func (c *Configuration) Default()

func (*Configuration) FromEnv

func (c *Configuration) FromEnv(envs map[string]string)

func (*Configuration) Validate

func (c *Configuration) Validate() (err error)

type File

type File interface {
	Write(item interface{}) error
	Read(item interface{}) error
}