conffile

Documentation

Overview

Package conffile wraps the read and write of configuration files

Index

• type File
  • func New(opts ...Opt) *File
  • func (f *File) Name() string
  • func (f *File) Open() (io.ReadCloser, error)
  • func (f *File) Write(rdr io.Reader) error
• type Opt
  • func WithDirName(dir, name string) Opt
  • func WithEnvDir(envVar, name string) Opt
  • func WithEnvFile(envVar string) Opt
  • func WithFS(fs rwfs.RWFS) Opt
  • func WithFullname(fullname string) Opt
  • func WithPerms(perms int) Opt

Types

type File

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

func New

func New(opts ...Opt) *File

New returns a new File

func (*File) Name

func (f *File) Name() string

func (*File) Open

func (f *File) Open() (io.ReadCloser, error)

func (*File) Write

func (f *File) Write(rdr io.Reader) error

type Opt

type Opt func(*File)

func WithDirName

func WithDirName(dir, name string) Opt

WithDirName determines the filename from a subdirectory in the user's HOME e.g. dir=".app", name="config.json", sets the fullname to "$HOME/.app/config.json"

func WithEnvDir

func WithEnvDir(envVar, name string) Opt

WithEnvDir sets the fullname to the environment value + filename if the environment variable is defined

func WithEnvFile

func WithEnvFile(envVar string) Opt

WithEnvFile sets the fullname to the environment value if defined

func WithFS

func WithFS(fs rwfs.RWFS) Opt

WithFS overrides the default OS filesystem

func WithFullname

func WithFullname(fullname string) Opt

WithFullname specifies the filename

func WithPerms

func WithPerms(perms int) Opt

WithPerms specifies the permissions to create a file with (default 0600)