ioutil

Documentation

Overview

MIT License * * Copyright (c) 2017 Roland Singer [roland.singer@desertbit.com] * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE.

Index

• Constants
• func AppendToFile(path string, values string) error
• func CopyDir(dst, src string, fns ...CopyDirFn) (err error)
• func CopyFile(dst, src string) (err error)
• func EnsureDirectory(path string) error
• func PathExists(path string) bool
• func PathNotExists(path string) bool
• func ReadFile(path string) (string, error)
• func ReadFileAs(path string, obj interface{}) error
• func ReadINIConfig(path string) (map[string]string, error)
• func WriteFile(dst string, src io.Reader, perm os.FileMode) (err error)
• func WriteJson(path string, obj interface{}) error
• func WriteString(path string, data string) bool
• type CopyDirFn
  • func IgnoreDestination() CopyDirFn
  • func ReplaceDestination() CopyDirFn
• type Reloader
  • func NewReloader(dir string, fs embed.FS, loadFn func(fsys iofs.FS)) *Reloader
  • func (r *Reloader) FS() iofs.FS
  • func (r *Reloader) ReloadIfTriggered()
• type Watcher
  • func (w *Watcher) Run(stopCh <-chan struct{}) error

Constants

const (
	TriggerFile = "trigger"
)

Functions

func AppendToFile

func AppendToFile(path string, values string) error

func CopyDir

func CopyDir(dst, src string, fns ...CopyDirFn) (err error)

CopyDir recursively copies a directory tree, attempting to preserve permissions. Source directory must exist, destination directory must *not* exist. Symlinks are ignored and skipped.

func CopyFile

func CopyFile(dst, src string) (err error)

CopyFile copies the contents of the file named src to the file named by dst. The file will be created if it does not already exist. If the destination file exists, all it's contents will be replaced by the contents of the source file. The file mode will be copied from the source and the copied data is synced/flushed to stable storage.

func EnsureDirectory

func EnsureDirectory(path string) error

func PathExists

func PathExists(path string) bool

func PathNotExists

func PathNotExists(path string) bool

func ReadFile

func ReadFile(path string) (string, error)

func ReadFileAs

func ReadFileAs(path string, obj interface{}) error

func ReadINIConfig

func ReadINIConfig(path string) (map[string]string, error)

ReadINIConfig loads a ini config file without any sections. Example: --- --- --- a=b c=d --- --- ---

func WriteFile

func WriteFile(dst string, src io.Reader, perm os.FileMode) (err error)

WriteFile writes the contents from src to dst using io.Copy. If dst does not exist, WriteFile creates it with permissions perm; otherwise WriteFile truncates it before writing.

func WriteJson

func WriteJson(path string, obj interface{}) error

func WriteString

func WriteString(path string, data string) bool

Types

type CopyDirFn

type CopyDirFn func(*options)

func IgnoreDestination

func IgnoreDestination() CopyDirFn

func ReplaceDestination

func ReplaceDestination() CopyDirFn

type Reloader

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

func NewReloader

func NewReloader(dir string, fs embed.FS, loadFn func(fsys iofs.FS)) *Reloader

func (*Reloader) FS

func (r *Reloader) FS() iofs.FS

func (*Reloader) ReloadIfTriggered

func (r *Reloader) ReloadIfTriggered()

type Watcher

type Watcher struct {
	WatchFiles []string
	WatchDir   string
	Reload     func() error
	// contains filtered or unexported fields
}

func (*Watcher) Run

func (w *Watcher) Run(stopCh <-chan struct{}) error