pathlib

Dec 19, 2023

Changes in this version

+ var ErrWalk = fmt.Errorf("walk control")

+ var ErrWalkSkipSubtree = fmt.Errorf("skip subtree: %w", ErrWalk)

+ var ErrWalkStop = fmt.Errorf("stop filesystem walk: %w", ErrWalk)

type Algorithm

+ const AlgorithmPostOrderDepthFirst

Nov 29, 2023

Changes in this version

type Algorithm

+ const AlgorithmPreOrderDepthFirst

type WalkOpts

+ SortChildren bool

type WalkOptsFunc

+ func WalkSortChildren(value bool) WalkOptsFunc

Nov 2, 2023

Changes in this version

+ type PathOpts func(p *Path)

+ func PathWithAfero(fs afero.Fs) PathOpts

+ func PathWithSeperator(sep string) PathOpts

Nov 2, 2023

Changes in this version

type Path

+ func (p *Path) Copy(other *Path) (int64, error)

May 13, 2023

Changes in this version

+ var ErrRelativeTo = fmt.Errorf("failed to make path relative to other")

Apr 8, 2023

Changes in this version

+ type WalkOptsFunc func(config *WalkOpts)

+ func WalkAlgorithm(algo Algorithm) WalkOptsFunc

+ func WalkDepth(depth int) WalkOptsFunc

+ func WalkFollowSymlinks(follow bool) WalkOptsFunc

+ func WalkMaximumFileSize(size int64) WalkOptsFunc

+ func WalkMinimumFileSize(size int64) WalkOptsFunc

+ func WalkVisitDirs(value bool) WalkOptsFunc

+ func WalkVisitFiles(value bool) WalkOptsFunc

+ func WalkVisitSymlinks(value bool) WalkOptsFunc

Oct 25, 2020

Changes in this version

type Path

+ func (p *Path) Clean() *Path

+ func (p *Path) OpenFileMode(flag int, perm os.FileMode) (*File, error)

+ func (p *Path) Readlink() (*Path, error)

+ func (p *Path) RelativeToStr(other string) (*Path, error)

+ func (p *Path) RenameStr(newname string) error

+ func (p *Path) SymlinkStr(target string) error

+ func (p *Path) WriteFileMode(data []byte, perm os.FileMode) error

Oct 13, 2020

Changes in this version

+ var DefaultDirMode = os.FileMode(0o755)

+ var DefaultFileMode = os.FileMode(0o644)

type Path

+ DefaultDirMode os.FileMode

+ func (p *Path) MkdirAllMode(perm os.FileMode) error

+ func (p *Path) MkdirMode(perm os.FileMode) error

Sep 26, 2020

Changes in this version

+ var ErrLstatNotPossible = fmt.Errorf("lstat is not possible")

Sep 26, 2020

Changes in this version

type Path

+ func (p *Path) DeepEquals(other *Path) (bool, error)

Sep 7, 2020

Changes in this version

type WalkOpts

+ MaximumFileSize int64

+ MinimumFileSize int64

+ VisitDirs bool

+ VisitFiles bool

+ VisitSymlinks bool

+ func (w *WalkOpts) MeetsMaximumSize(size int64) bool

+ func (w *WalkOpts) MeetsMinimumSize(size int64) bool

Sep 7, 2020

Changes in this version

+ type Algorithm int

type WalkOpts

+ Algorithm Algorithm

Sep 7, 2020

Changes in this version

+ var ErrInfoIsNil = fmt.Errorf("provided os.Info object was nil")

+ var ErrInvalidAlgorithm = fmt.Errorf("invalid algorithm specified")

+ var ErrStopWalk = fmt.Errorf("stop filesystem walk")

+ func AlgorithmBasic() string

+ func AlgorithmDepthFirst() string

+ type Walk struct

+ Opts *WalkOpts

+ func NewWalk(root *Path) (*Walk, error)

+ func NewWalkWithOpts(root *Path, opts *WalkOpts) (*Walk, error)

+ func (w *Walk) Walk(walkFn WalkFunc) error

+ type WalkFunc func(path *Path, info os.FileInfo, err error) error

+ type WalkOpts struct

+ Depth int

+ FIFOQueueSize int

+ FollowSymlinks bool

+ WalkAlgorithm string

+ func DefaultWalkOpts() *WalkOpts

Jul 17, 2020

Changes in this version

+ func IsDir(fileInfo os.FileInfo) bool

+ func IsFile(fileInfo os.FileInfo) (bool, error)

+ func IsSymlink(fileInfo os.FileInfo) (bool, error)

+ func Mtime(fileInfo os.FileInfo) (time.Time, error)

+ func Size(fileInfo os.FileInfo) int64

type Path

+ func (p *Path) Lstat() (os.FileInfo, bool, error)

+ func (p *Path) Size() (int64, error)

Jul 16, 2020

Changes in this version

type Path

+ Sep string

+ func (p *Path) JoinPath(path *Path) *Path

+ func (p *Path) Parts() []string

+ func (p *Path) ResolveAll() (*Path, error)

+ func (p *Path) String() string

Jul 7, 2020

Changes in this version

+ type File struct

Jul 6, 2020

Changes in this version

type Path

+ DefaultFileMode os.FileMode

+ func (p *Path) Create() (afero.File, error)

+ func (p *Path) DirExists() (bool, error)

+ func (p *Path) FileContainsAnyBytes(subslices [][]byte) (bool, error)

+ func (p *Path) FileContainsBytes(subslice []byte) (bool, error)

+ func (p *Path) Fs() afero.Fs

+ func (p *Path) IsEmpty() (bool, error)

+ func (p *Path) Open() (afero.File, error)

+ func (p *Path) OpenFile(flag int, perm os.FileMode) (afero.File, error)

+ func (p *Path) SafeWriteReader(r io.Reader) error

+ func (p *Path) Walk(walkFn filepath.WalkFunc) error

+ func (p *Path) WriteReader(r io.Reader) error

Jun 29, 2020

Changes in this version

type Path

+ func (p *Path) Mtime() (time.Time, error)

Jun 28, 2020

Changes in this version

+ var ErrDoesNotImplement = errors.Errorf("doesn't implement required interface")

+ type Path struct

+ func Glob(fs afero.Fs, pattern string) ([]*Path, error)

+ func NewPath(path string) *Path

+ func NewPathAfero(path string, fs afero.Fs) *Path

+ func (p *Path) Afero() afero.Afero

+ func (p *Path) Chmod(mode os.FileMode) error

+ func (p *Path) Chtimes(atime time.Time, mtime time.Time) error

+ func (p *Path) Equals(other *Path) (bool, error)

+ func (p *Path) Exists() (bool, error)

+ func (p *Path) GetLatest() (*Path, error)

+ func (p *Path) Glob(pattern string) ([]*Path, error)

+ func (p *Path) IsAbsolute() bool

+ func (p *Path) IsDir() (bool, error)

+ func (p *Path) IsFile() (bool, error)

+ func (p *Path) IsSymlink() (bool, error)

+ func (p *Path) Join(elems ...string) *Path

+ func (p *Path) Mkdir(perm os.FileMode) error

+ func (p *Path) MkdirAll(perm os.FileMode) error

+ func (p *Path) Name() string

+ func (p *Path) Parent() *Path

+ func (p *Path) Path() string

+ func (p *Path) ReadDir() ([]os.FileInfo, error)

+ func (p *Path) ReadFile() ([]byte, error)

+ func (p *Path) RelativeTo(other *Path) (*Path, error)

+ func (p *Path) Remove() error

+ func (p *Path) RemoveAll() error

+ func (p *Path) Rename(target string) (*Path, error)

+ func (p *Path) RenamePath(target *Path) (*Path, error)

+ func (p *Path) Resolve() (*Path, error)

+ func (p *Path) Stat() (os.FileInfo, error)

+ func (p *Path) Symlink(target *Path) error

+ func (p *Path) WriteFile(data []byte, perm os.FileMode) error