folderutil

README

folderutil

The package contains various helpers to interact with folders

Documentation

Index

• Constants
• Variables
• func GetFiles(root string) ([]string, error)
• func HomeDirOrDefault(defaultDirectory string) string
• func IsUnixOS() bool
• func IsWindowsOS() bool
• type PathInfo
  • func NewPathInfo(path string) (PathInfo, error)
  • func (pathInfo PathInfo) MeshWith(anotherPath string) ([]string, error)
  • func (pathInfo PathInfo) Paths() ([]string, error)

Constants

const (
	UnixPathSeparator    = "/"
	WindowsPathSeparator = "\\"
)

Variables

var Separator = string(os.PathSeparator)

Separator evaluated at runtime

Functions

func GetFiles

func GetFiles(root string) ([]string, error)

GetFiles within a folder

func HomeDirOrDefault

func HomeDirOrDefault(defaultDirectory string) string

HomeDirectory

func IsUnixOS

func IsUnixOS() bool

func IsWindowsOS

func IsWindowsOS() bool

Types

type PathInfo

type PathInfo struct {
	IsAbsolute         bool
	RootPath           string
	Parts              []string
	PartsWithSeparator []string
}

PathInfo about a folder

func NewPathInfo

func NewPathInfo(path string) (PathInfo, error)

NewPathInfo returns info about a given path

func (PathInfo) MeshWith

func (pathInfo PathInfo) MeshWith(anotherPath string) ([]string, error)

MeshWith combine all values from Path with another provided path

func (PathInfo) Paths

func (pathInfo PathInfo) Paths() ([]string, error)

Returns all possible combination of the various levels of the path parts