fs

Documentation

Index

• func AppendToFile(s string, filename string) error
• func EnsureDir(dir string) error
• func FileExist(path string) bool
• func GetDir(devEnv bool) (string, error)
• func OverwriteFile(s string, filename string) error
• func OverwriteFileBytes(b []byte, filename string) error
• func OverwriteFileValueIndent(v interface{}, filename string) error
• func Write(s string, w io.StringWriter) error
• func WriteBytes(b []byte, w io.Writer) error
• type FileWriter
  • func (fw *FileWriter) EnqueueWrite(data string) (err error)
  • func (fw *FileWriter) Init(filePath string, queueLength int) (err error)
  • func (fw *FileWriter) Stop() (err error)

Functions

func AppendToFile

func AppendToFile(s string, filename string) error

AppendToFile write s to the end of filename

func EnsureDir

func EnsureDir(dir string) error

EnsureDir creates directory if it doesnt exist

func FileExist

func FileExist(path string) bool

FileExist check if path exist

func GetDir

func GetDir(devEnv bool) (string, error)

GetDir returns the program root directory

func OverwriteFile

func OverwriteFile(s string, filename string) error

OverwriteFile truncate filename and write s into it

func OverwriteFileBytes

func OverwriteFileBytes(b []byte, filename string) error

OverwriteFileBytes truncate filename and write b []bytes into it

func OverwriteFileValueIndent

func OverwriteFileValueIndent(v interface{}, filename string) error

OverwriteFileValueIndent marshall v into indented json, then truncate the file filename and write the marshalled bytes into it

func Write

func Write(s string, w io.StringWriter) error

func WriteBytes

func WriteBytes(b []byte, w io.Writer) error

Types

type FileWriter

type FileWriter struct {
	sync.Mutex
	// contains filtered or unexported fields
}

FileWriter allows concurrent writes to a file

func (*FileWriter) EnqueueWrite

func (fw *FileWriter) EnqueueWrite(data string) (err error)

EnqueueWrite writes string to the target file

func (*FileWriter) Init

func (fw *FileWriter) Init(filePath string, queueLength int) (err error)

Init setup the FileWriter

func (*FileWriter) Stop

func (fw *FileWriter) Stop() (err error)

Stop ends the file writer