fpath

Documentation

Overview

Package fpath implements cross-platform file and object path handling.

Index

• func ApplicationDir(subdir ...string) string
• func AtomicWriteFile(outfile string, data []byte, _ os.FileMode) (err error)
• func EditFile(fileToEdit string) error
• func GetTempData(ctx context.Context) (string, bool, bool)
• func IsRoot(path string) bool
• func IsValidSetupDir(name string) (ok bool, err error)
• func IsWritable(filepath string) (bool, error)
• func WithTempData(ctx context.Context, directory string, inmemory bool) context.Context
• type FPath
  • func New(p string) (FPath, error)
  • func (p FPath) Base() string
  • func (p FPath) Bucket() string
  • func (p FPath) IsLocal() bool
  • func (p FPath) Join(segment string) FPath
  • func (p FPath) Path() string
  • func (p FPath) String() string

Functions

func ApplicationDir

func ApplicationDir(subdir ...string) string

ApplicationDir returns best base directory for specific OS.

func AtomicWriteFile

func AtomicWriteFile(outfile string, data []byte, _ os.FileMode) (err error)

AtomicWriteFile is a helper to atomically write the data to the outfile.

func EditFile

func EditFile(fileToEdit string) error

EditFile opens the best OS-specific text editor we can find.

func GetTempData

func GetTempData(ctx context.Context) (string, bool, bool)

GetTempData returns if temporary data should be stored in memory or on disk.

func IsRoot

func IsRoot(path string) bool

IsRoot returns whether path is the root directory.

func IsValidSetupDir

func IsValidSetupDir(name string) (ok bool, err error)

IsValidSetupDir checks if directory is valid for setup configuration.

func IsWritable

func IsWritable(filepath string) (bool, error)

IsWritable determines if a directory is writeable.

func WithTempData

func WithTempData(ctx context.Context, directory string, inmemory bool) context.Context

WithTempData creates context with information how store temporary data, in memory or on disk.

Types

type FPath

type FPath struct {
	// contains filtered or unexported fields
}

FPath is an OS independent path handling structure.

func New

func New(p string) (FPath, error)

New creates new FPath from the given URL.

func (FPath) Base

func (p FPath) Base() string

Base returns the last segment of the path.

func (FPath) Bucket

func (p FPath) Bucket() string

Bucket returns the first segment of path.

func (FPath) IsLocal

func (p FPath) IsLocal() bool

IsLocal returns whether the path refers to local or remote location.

func (FPath) Join

func (p FPath) Join(segment string) FPath

Join is appends the given segment to the path.

func (FPath) Path

func (p FPath) Path() string

Path returns the URL path without the scheme.

func (FPath) String

func (p FPath) String() string

String returns the entire URL (untouched).