gofile

README

gofile

File and directory management libraries.

Example of use

    // determine if a file or folder exists
    gofile.IsExists("/tmp/test/")

    // get the path to program execution
    gofile.GetRunPath()

    // get all files in a directory (absolute path)
    gofile.ListFiles("/tmp/")

    // get all files in a directory by prefix (absolute path)
    gofile.ListFiles(dir, WithPrefix("READ"))

    // get all files in a directory by suffix (absolute path)
    gofile.ListFiles(dir, WithSuffix(".go"))

    // get all files in a directory based on a string (absolute path)
    gofile.ListFiles(dir, WithContain("file"))

Documentation

Overview

Package gofile is file and directory management libraries.

Index

• func CreateDir(dir string) error
• func FilterDirs(dirs []string, opts Option) []string
• func FindAllSubBytes(data []byte, start []byte, end []byte) [][]byte
• func FindSubBytes(data []byte, start []byte, end []byte) []byte
• func FindSubBytesNotIn(data []byte, start []byte, end []byte) []byte
• func FuzzyMatchFiles(f string) []string
• func GetDir(filePath string) string
• func GetFileDir(filePath string) string
• func GetFilename(filePath string) string
• func GetFilenameWithoutSuffix(filePath string) string
• func GetPathDelimiter() string
• func GetRunPath() string
• func IsExists(f string) bool
• func IsWindows() bool
• func Join(elem ...string) string
• func ListDirs(specifiedDir string) ([]string, error)
• func ListDirsAndFiles(dirPath string) (map[string][]string, error)
• func ListFiles(dirPath string, opts ...Option) ([]string, error)
• func ListSubDirs(root string, subDir string) ([]string, error)
• type Option
  • func WithContain(name string) Option
  • func WithNoAbsolutePath() Option
  • func WithPrefix(name string) Option
  • func WithSuffix(name string) Option

Functions

func CreateDir

func CreateDir(dir string) error

CreateDir create dir

func FilterDirs

func FilterDirs(dirs []string, opts Option) []string

FilterDirs filter directories that meet the criteria

func FindAllSubBytes

func FindAllSubBytes(data []byte, start []byte, end []byte) [][]byte

FindAllSubBytes find all substrings, including start and end marks

func FindSubBytes

func FindSubBytes(data []byte, start []byte, end []byte) []byte

FindSubBytes find first substrings, including start and end marks

func FindSubBytesNotIn

func FindSubBytesNotIn(data []byte, start []byte, end []byte) []byte

FindSubBytesNotIn find substrings, excluding start and end tags

func FuzzyMatchFiles

func FuzzyMatchFiles(f string) []string

FuzzyMatchFiles fuzzy matching of documents, * only

func GetDir

func GetDir(filePath string) string

GetDir get dir, not include the last separator

func GetFileDir

func GetFileDir(filePath string) string

GetFileDir get dir, include the last separator

func GetFilename

func GetFilename(filePath string) string

GetFilename get file name

func GetFilenameWithoutSuffix

func GetFilenameWithoutSuffix(filePath string) string

GetFilenameWithoutSuffix get file name without suffix

func GetPathDelimiter

func GetPathDelimiter() string

GetPathDelimiter get separator by system type

func GetRunPath

func GetRunPath() string

GetRunPath get the absolute path of the program execution

func IsExists

func IsExists(f string) bool

IsExists determine if a file or folder exists

func IsWindows

func IsWindows() bool

IsWindows determining whether a window environment

func Join

func Join(elem ...string) string

Join joins any number of path elements into a single path

func ListDirs

func ListDirs(specifiedDir string) ([]string, error)

ListDirs list all sub dirs, not including itself

func ListDirsAndFiles

func ListDirsAndFiles(dirPath string) (map[string][]string, error)

ListDirsAndFiles iterates through all subdirectories of the specified directory, returning the absolute path to the file

func ListFiles

func ListFiles(dirPath string, opts ...Option) ([]string, error)

ListFiles iterates over all files in the specified directory, returning the absolute path to the file

func ListSubDirs

func ListSubDirs(root string, subDir string) ([]string, error)

ListSubDirs list all sub dirs that have the specified sub dir, if sub dir is empty, return all sub dirs

Types

type Option

type Option func(*options)

Option set the file options.

func WithContain

func WithContain(name string) Option

WithContain set contain matching

func WithNoAbsolutePath

func WithNoAbsolutePath() Option

WithNoAbsolutePath set no absolute path

func WithPrefix

func WithPrefix(name string) Option

WithPrefix set prefix matching

func WithSuffix

func WithSuffix(name string) Option

WithSuffix set suffix matching