Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pathlib

package module

Go to main page

Versions in this module

v0

v0.1.0

Aug 27, 2025

Changes in this version

+ type Beholder interface

+ Exists func() bool

+ Lstat func() (Info[P], error)

+ Stat func() (Info[P], error)

+ type Changer interface

+ Chmod func(fs.FileMode) error

+ Chown func(uid, gid int) error

+ type Dir PathStr

+ func Cwd() (Dir, error)

+ func TempDir() Dir

+ func UserCacheDir() (Dir, error)

+ func UserConfigDir() (Dir, error)

+ func UserHomeDir() (Dir, error)

+ func (d Dir) Abs() (Dir, error)

+ func (d Dir) BaseName() string

+ func (d Dir) Chdir() (Dir, error)

+ func (d Dir) Chmod(mode os.FileMode) error

+ func (d Dir) Chown(uid int, gid int) error

+ func (d Dir) Clean() Dir

+ func (d Dir) Eq(other Dir) (equivalent bool)

+ func (d Dir) Exists() bool

+ func (d Dir) ExpandUser() (Dir, error)

+ func (d Dir) Ext() string

+ func (d Dir) Glob(pattern string) ([]PathStr, error)

+ func (d Dir) IsAbsolute() bool

+ func (d Dir) IsLocal() bool

+ func (d Dir) Join(parts ...string) PathStr

+ func (d Dir) Localize() (Dir, error)

+ func (d Dir) Lstat() (result Info[Dir], err error)

+ func (d Dir) Make(perm fs.FileMode) (result Dir, err error)

+ func (d Dir) MakeAll(perm, parentPerm fs.FileMode) (result Dir, err error)

+ func (d Dir) Parent() Dir

+ func (d Dir) Parts() []string

+ func (d Dir) Read() ([]fs.DirEntry, error)

+ func (d Dir) Rel(base Dir) (Dir, error)

+ func (d Dir) Remove() error

+ func (d Dir) RemoveAll() (Dir, error)

+ func (d Dir) Rename(newPath PathStr) (Dir, error)

+ func (d Dir) Stat() (result Info[Dir], err error)

+ func (d Dir) String() string

+ func (d Dir) Walk(callback func(path PathStr, d fs.DirEntry, err error) error) error

+ type File PathStr

+ func (f File) Abs() (File, error)

+ func (f File) BaseName() string

+ func (f File) Chmod(mode os.FileMode) error

+ func (f File) Chown(uid int, gid int) error

+ func (f File) Clean() File

+ func (f File) Eq(other File) bool

+ func (f File) Exists() bool

+ func (f File) ExpandUser() (File, error)

+ func (f File) Ext() string

+ func (f File) IsAbsolute() bool

+ func (f File) IsLocal() bool

+ func (f File) Join(parts ...string) PathStr

+ func (f File) Localize() (File, error)

+ func (f File) Lstat() (info Info[File], err error)

+ func (f File) Make(perm fs.FileMode) (FileHandle, error)

+ func (f File) MakeAll(perm, parentPerm fs.FileMode) (result FileHandle, err error)

+ func (f File) Open(flag int, perm fs.FileMode) (FileHandle, error)

+ func (f File) Parent() Dir

+ func (f File) Parts() []string

+ func (f File) Read() ([]byte, error)

+ func (f File) Rel(base Dir) (File, error)

+ func (f File) Remove() error

+ func (f File) Rename(newPath PathStr) (File, error)

+ func (f File) Stat() (Info[File], error)

+ func (f File) String() string

+ type FileHandle interface

+ Fd func() uintptr

+ Name func() string

+ Path func() File

+ SetDeadline func(deadline time.Time) error

+ SetReadDeadline func(deadline time.Time) error

+ SetWriteDeadline func(deadline time.Time) error

+ SyscallConn func() (syscall.RawConn, error)

+ Truncate func(size int64) error

+ type Info interface

+ Path func() P

+ type Kind interface

+ type Maker interface

+ Make func(perm fs.FileMode) (T, error)

+ MakeAll func(perm, parentPerm fs.FileMode) (T, error)

+ type PathStr string

+ func (p PathStr) Abs() (PathStr, error)

+ func (p PathStr) Ancestors() iter.Seq[Dir]

+ func (p PathStr) AsDir() Dir

+ func (p PathStr) AsFile() File

+ func (p PathStr) AsSymlink() Symlink

+ func (p PathStr) BaseName() string

+ func (p PathStr) Chmod(mode os.FileMode) error

+ func (p PathStr) Chown(uid int, gid int) error

+ func (p PathStr) Clean() PathStr

+ func (p PathStr) Eq(q PathStr) bool

+ func (p PathStr) Exists() bool

+ func (p PathStr) ExpandUser() (PathStr, error)

+ func (p PathStr) Ext() string

+ func (p PathStr) IsAbsolute() bool

+ func (p PathStr) IsLocal() bool

+ func (p PathStr) Join(segments ...string) PathStr

+ func (p PathStr) Localize() (PathStr, error)

+ func (p PathStr) Lstat() (Info[PathStr], error)

+ func (p PathStr) Parent() Dir

+ func (p PathStr) Parts() (parts []string)

+ func (p PathStr) Read() (any, error)

+ func (p PathStr) Rel(base Dir) (PathStr, error)

+ func (p PathStr) Remove() error

+ func (p PathStr) Rename(newPath PathStr) (PathStr, error)

+ func (p PathStr) Stat() (Info[PathStr], error)

+ func (p PathStr) String() string

+ type PurePath interface

+ BaseName func() string

+ Ext func() string

+ IsAbsolute func() bool

+ IsLocal func() bool

+ Join func(segments ...string) PathStr

+ Parent func() Dir

+ Parts func() []string

+ type Readable interface

+ Read func() (T, error)

+ type Remover interface

+ Remove func() error

+ Rename func(newPath PathStr) (P, error)

+ type Symlink PathStr

+ func (s Symlink) Abs() (Symlink, error)

+ func (s Symlink) BaseName() string

+ func (s Symlink) Chmod(mode os.FileMode) error

+ func (s Symlink) Chown(uid int, gid int) error

+ func (s Symlink) Clean() Symlink

+ func (s Symlink) Eq(other Symlink) bool

+ func (s Symlink) Exists() bool

+ func (s Symlink) ExpandUser() (Symlink, error)

+ func (s Symlink) Ext() string

+ func (s Symlink) IsAbsolute() bool

+ func (s Symlink) IsLocal() bool

+ func (s Symlink) Join(parts ...string) PathStr

+ func (s Symlink) LinkTo(target PathStr) (Symlink, error)

+ func (s Symlink) Localize() (Symlink, error)

+ func (s Symlink) Lstat() (result Info[Symlink], err error)

+ func (s Symlink) Parent() Dir

+ func (s Symlink) Parts() []string

+ func (s Symlink) Read() (PathStr, error)

+ func (s Symlink) Rel(base Dir) (Symlink, error)

+ func (s Symlink) Remove() error

+ func (s Symlink) Rename(newPath PathStr) (Symlink, error)

+ func (s Symlink) Stat() (Info[Symlink], error)

+ func (s Symlink) String() string

+ type Transformer interface

+ Abs func() (P, error)

+ Clean func() P

+ Eq func(other P) bool

+ ExpandUser func() (P, error)

+ Localize func() (P, error)

+ Rel func(target Dir) (P, error)

+ String func() string

+ type WrongTypeOnDisk struct

+ Observed Info[P]

+ func (w WrongTypeOnDisk[P]) Error() string

v0.0.1-alpha.2

Aug 25, 2025

v0.0.1-alpha

Aug 25, 2025