pathfixer

Documentation

Index

• func Fix(isExpand bool, path string) string
• func FixIf(isNormalize, isExpand bool, path string) string
• func FixMany(isExpand bool, paths ...string) []string
• type Location
  • func NewLocation(location string) *Location
  • func NewLocationUsingOptions(location string, options PathOptions) *Location
  • func (it *Location) ClonePath() *Location
  • func (it *Location) CompiledPath() string
  • func (it *Location) ExistStat() *chmodhelper.PathExistStat
  • func (it *Location) FileInfo() os.FileInfo
  • func (it *Location) FileMode() os.FileMode
  • func (it *Location) HasPath() bool
  • func (it *Location) IsDir() bool
  • func (it *Location) IsEmptyPath() bool
  • func (it *Location) IsEqual(another *Location) bool
  • func (it *Location) IsEqualWithoutOptions(another *Location) bool
  • func (it *Location) IsExistButDir() bool
  • func (it *Location) IsExistButFile() bool
  • func (it *Location) IsFile() bool
  • func (it *Location) IsInvalid() bool
  • func (it *Location) IsInvalidPath() bool
  • func (it *Location) IsPathExist() bool
  • func (it *Location) SafeFileMode() os.FileMode
• type PathOptions
  • func (it *PathOptions) ClonePathOptions() *PathOptions
  • func (it *PathOptions) GetFixedPath(location string) string
  • func (it *PathOptions) GetFixedPathJoined(location1, location2 string) string
  • func (it *PathOptions) GetFixedPathJoinedMany(locations ...string) string
  • func (it *PathOptions) IsEqual(another *PathOptions) bool
  • func (it *PathOptions) Join(location1, location2 string) string

Functions

func Fix

func Fix(isExpand bool, path string) string

func FixIf

func FixIf(isNormalize, isExpand bool, path string) string

func FixMany

func FixMany(isExpand bool, paths ...string) []string

Types

type Location

type Location struct {
	PathOptions
	Path string `json:"Location,omitempty"` // empty path will be ignored from applying, must use CompiledPath
	// contains filtered or unexported fields
}

Location Don't use Path Directly but use CompiledPath

func NewLocation

func NewLocation(location string) *Location

func NewLocationUsingOptions

func NewLocationUsingOptions(
	location string,
	options PathOptions,
) *Location

func (*Location) ClonePath

func (it *Location) ClonePath() *Location

func (*Location) CompiledPath

func (it *Location) CompiledPath() string

func (*Location) ExistStat

func (it *Location) ExistStat() *chmodhelper.PathExistStat

func (*Location) FileInfo

func (it *Location) FileInfo() os.FileInfo

func (*Location) FileMode

func (it *Location) FileMode() os.FileMode

func (*Location) HasPath

func (it *Location) HasPath() bool

func (*Location) IsDir

func (it *Location) IsDir() bool

func (*Location) IsEmptyPath

func (it *Location) IsEmptyPath() bool

func (*Location) IsEqual

func (it *Location) IsEqual(another *Location) bool

func (*Location) IsEqualWithoutOptions

func (it *Location) IsEqualWithoutOptions(another *Location) bool

func (*Location) IsExistButDir

func (it *Location) IsExistButDir() bool

func (*Location) IsExistButFile

func (it *Location) IsExistButFile() bool

func (*Location) IsFile

func (it *Location) IsFile() bool

func (*Location) IsInvalid

func (it *Location) IsInvalid() bool

func (*Location) IsInvalidPath

func (it *Location) IsInvalidPath() bool

func (*Location) IsPathExist

func (it *Location) IsPathExist() bool

IsPathExist returns true if exist on the file system

func (*Location) SafeFileMode

func (it *Location) SafeFileMode() os.FileMode

type PathOptions

type PathOptions struct {
	IsContinueOnError bool `json:"IsContinueOnError,omitempty"`
	IsNormalize       bool `json:"IsNormalize,omitempty"`
	IsExpandEnvVar    bool `json:"IsExpandEnvVariable,omitempty"` // can expand environment variables with %{Name} $Name %{Java_home} ${Java_HOME}
	IsRecursive       bool `json:"IsRecursive,omitempty"`
	IsSkipOnInvalid   bool `json:"IsSkipOnInvalid,omitempty"`
	IsSkipOnExist     bool `json:"IsSkipOnExist,omitempty"`
	IsSkipOnEmpty     bool `json:"IsSkipOnEmpty,omitempty"`
	IsRelative        bool `json:"IsRelative,omitempty"`
}

func (*PathOptions) ClonePathOptions

func (it *PathOptions) ClonePathOptions() *PathOptions

func (*PathOptions) GetFixedPath

func (it *PathOptions) GetFixedPath(location string) string

func (*PathOptions) GetFixedPathJoined

func (it *PathOptions) GetFixedPathJoined(location1, location2 string) string

func (*PathOptions) GetFixedPathJoinedMany

func (it *PathOptions) GetFixedPathJoinedMany(
	locations ...string,
) string

func (*PathOptions) IsEqual

func (it *PathOptions) IsEqual(another *PathOptions) bool

func (*PathOptions) Join

func (it *PathOptions) Join(location1, location2 string) string