gardenpath

README

/pkg/gardenpath

Purpose of /pkg/gardenpath:

• To implment a common representation of file path.

Documentation

Index

• Variables
• type GardenPath
  • func New(path string) (GardenPath, error)
  • func NewCheckEnv(path string) (gp GardenPath, notFound []string, err error)
  • func (p GardenPath) Abs() string
  • func (p GardenPath) Copy() GardenPath
  • func (p GardenPath) IsEqual(other GardenPath) bool
  • func (p GardenPath) Last() string
  • func (p GardenPath) Parent() GardenPath

Variables

var ErrEnvVarNotSet = fmt.Errorf("env var not set")

Types

type GardenPath

type GardenPath []string

GardenPath is a smart path representation. It is a sequence of directory names starting from root directory.

The first element represents the root directory:

• linux or else: empty string
• windows: volume name (e.g. C:)

func New

func New(path string) (GardenPath, error)

New constructor handles:

1. Clean dot and double dot
2. tilde replacement,
3. absolute path conversion,
4. trailing slash removal.

It returns nil if the path is empty.

func NewCheckEnv

func NewCheckEnv(path string) (gp GardenPath, notFound []string, err error)

Returns a list of env vars that were not found.

func (GardenPath) Abs

func (p GardenPath) Abs() string

Get absolute path.

func (GardenPath) Copy

func (p GardenPath) Copy() GardenPath

func (GardenPath) IsEqual

func (p GardenPath) IsEqual(other GardenPath) bool

func (GardenPath) Last

func (p GardenPath) Last() string

Return the last element.

func (GardenPath) Parent

func (p GardenPath) Parent() GardenPath

Return the parent path. Technically it returns [0:len(p)-1].