files

Documentation

Index

• Constants
• func CheckAndCreateDir(path string)
• func CreateDirIfNotExist(path string) (existed bool, err error)
• func CreateFile(filename string, path string) (file *os.File)
• func DeleteFileOrDir(path string)
• func FileIsJson(filename string) bool
• func FileIsYaml(filename string) bool
• func GetAbsPath(path string) string
• func LoadYamlFileToStruct[T any](path string) (*T, error)
• func OpenFileAtPath(path string, homepath string) (reader *os.File, err error)
• func PathExists(filePath string) (exists bool)
• func RemoveDir(path string)
• func WriteStringContentsToFile(path string, contents string, force bool) error
• func WriteStructToFile(target any, filename string, path string)
• func WriteStructsToFile(target any, filename string, path string, createDir bool) (exportCnt int)
• type FileDecoder
• type FileEncoder
• type FileInfo
  • func GetDirsAtPath(path string, createIfNotExit bool) (results []*FileInfo)
  • func GetFilesAtPath(path string, excludeDirs bool) (results []*FileInfo)
  • func NewFileInfo(name string, absPath string) *FileInfo
  • func NewFileInfoFromPath(path string) *FileInfo
  • func (fi *FileInfo) AbsFilePath() string
  • func (fi *FileInfo) Exists() bool
  • func (fi *FileInfo) GetFileInfo(name string, absPath string) os.FileInfo
  • func (fi *FileInfo) MoveToPath(path string)
  • func (fi *FileInfo) Open() (*os.File, error)
  • func (fi *FileInfo) OpenForReading() *os.File
  • func (fi *FileInfo) OpenForWriting(truncate bool) *os.File

Constants

const JSON string = "json"

const PathSeparator = string(os.PathSeparator)

const YAML string = "yaml"

const YML string = "yml"

Functions

func CheckAndCreateDir

func CheckAndCreateDir(path string)

func CreateDirIfNotExist

func CreateDirIfNotExist(path string) (existed bool, err error)

func CreateFile

func CreateFile(filename string, path string) (file *os.File)

func DeleteFileOrDir

func DeleteFileOrDir(path string)

func FileIsJson

func FileIsJson(filename string) bool

func FileIsYaml

func FileIsYaml(filename string) bool

func GetAbsPath

func GetAbsPath(path string) string

func LoadYamlFileToStruct

func LoadYamlFileToStruct[T any](path string) (*T, error)

func OpenFileAtPath

func OpenFileAtPath(path string, homepath string) (reader *os.File, err error)

func PathExists

func PathExists(filePath string) (exists bool)

func RemoveDir

func RemoveDir(path string)

func WriteStringContentsToFile

func WriteStringContentsToFile(path string, contents string, force bool) error

func WriteStructToFile

func WriteStructToFile(target any, filename string, path string)

func WriteStructsToFile

func WriteStructsToFile(target any, filename string, path string, createDir bool) (exportCnt int)

Types

type FileDecoder

type FileDecoder interface {
	Decode(v any) error
}

type FileEncoder

type FileEncoder interface {
	Encode(v any) (err error)
}

type FileInfo

type FileInfo struct {
	Name        string
	BaseAbsPath string
	Info        os.FileInfo
	IsDir       bool
}

func GetDirsAtPath

func GetDirsAtPath(path string, createIfNotExit bool) (results []*FileInfo)

func GetFilesAtPath

func GetFilesAtPath(path string, excludeDirs bool) (results []*FileInfo)

func NewFileInfo

func NewFileInfo(name string, absPath string) *FileInfo

func NewFileInfoFromPath

func NewFileInfoFromPath(path string) *FileInfo

func (*FileInfo) AbsFilePath

func (fi *FileInfo) AbsFilePath() string

func (*FileInfo) Exists

func (fi *FileInfo) Exists() bool

func (*FileInfo) GetFileInfo

func (fi *FileInfo) GetFileInfo(name string, absPath string) os.FileInfo

func (*FileInfo) MoveToPath

func (fi *FileInfo) MoveToPath(path string)

func (*FileInfo) Open

func (fi *FileInfo) Open() (*os.File, error)

func (*FileInfo) OpenForReading

func (fi *FileInfo) OpenForReading() *os.File

func (*FileInfo) OpenForWriting

func (fi *FileInfo) OpenForWriting(truncate bool) *os.File