fs

Documentation

Overview

Package fs implements an OS independent abstraction of a file system suitable for backup purposes.

Index

• func Chmod(name string, mode os.FileMode) error
• func Chtimes(name string, atime time.Time, mtime time.Time) error
• func Create(name string) (*os.File, error)
• func DeviceID(fi os.FileInfo) (deviceID uint64, err error)
• func HasPathPrefix(base, p string) bool
• func Link(oldname, newname string) error
• func Lstat(name string) (os.FileInfo, error)
• func Mkdir(name string, perm os.FileMode) error
• func MkdirAll(path string, perm os.FileMode) error
• func OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)
• func Readlink(name string) (string, error)
• func Remove(name string) error
• func RemoveAll(path string) error
• func RemoveIfExists(filename string) error
• func Rename(oldpath, newpath string) error
• func Stat(name string) (os.FileInfo, error)
• func Symlink(oldname, newname string) error
• func TempFile(dir, prefix string) (f *os.File, err error)
• func Walk(root string, walkFn filepath.WalkFunc) error
• type File
  • func Open(name string) (File, error)

Functions

func Chmod

func Chmod(name string, mode os.FileMode) error

Chmod changes the mode of the named file to mode.

func Chtimes

func Chtimes(name string, atime time.Time, mtime time.Time) error

Chtimes changes the access and modification times of the named file, similar to the Unix utime() or utimes() functions.

The underlying filesystem may truncate or round the values to a less precise time unit. If there is an error, it will be of type *PathError.

func Create

func Create(name string) (*os.File, error)

Create creates the named file with mode 0666 (before umask), truncating it if it already exists. If successful, methods on the returned File can be used for I/O; the associated file descriptor has mode O_RDWR. If there is an error, it will be of type *PathError.

func DeviceID

func DeviceID(fi os.FileInfo) (deviceID uint64, err error)

DeviceID extracts the device ID from an os.FileInfo object by casting it to syscall.Stat_t

func HasPathPrefix

func HasPathPrefix(base, p string) bool

HasPathPrefix returns true if p is a subdir of (or a file within) base. It assumes a file system which is case sensitive. If the paths are not of the same type (one is relative, the other is absolute), false is returned.

func Link

func Link(oldname, newname string) error

Link creates newname as a hard link to oldname. If there is an error, it will be of type *LinkError.

func Lstat

func Lstat(name string) (os.FileInfo, error)

Lstat returns the FileInfo structure describing the named file. If the file is a symbolic link, the returned FileInfo describes the symbolic link. Lstat makes no attempt to follow the link. If there is an error, it will be of type *PathError.

func Mkdir

func Mkdir(name string, perm os.FileMode) error

Mkdir creates a new directory with the specified name and permission bits. If there is an error, it will be of type *PathError.

func MkdirAll

func MkdirAll(path string, perm os.FileMode) error

MkdirAll creates a directory named path, along with any necessary parents, and returns nil, or else returns an error. The permission bits perm are used for all directories that MkdirAll creates. If path is already a directory, MkdirAll does nothing and returns nil.

func OpenFile

func OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)

OpenFile is the generalized open call; most users will use Open or Create instead. It opens the named file with specified flag (O_RDONLY etc.) and perm, (0666 etc.) if applicable. If successful, methods on the returned File can be used for I/O. If there is an error, it will be of type *PathError.

func Readlink

func Readlink(name string) (string, error)

Readlink returns the destination of the named symbolic link. If there is an error, it will be of type *PathError.

func Remove

func Remove(name string) error

Remove removes the named file or directory. If there is an error, it will be of type *PathError.

func RemoveAll

func RemoveAll(path string) error

RemoveAll removes path and any children it contains. It removes everything it can but returns the first error it encounters. If the path does not exist, RemoveAll returns nil (no error).

func RemoveIfExists

func RemoveIfExists(filename string) error

RemoveIfExists removes a file, returning no error if it does not exist.

func Rename

func Rename(oldpath, newpath string) error

Rename renames (moves) oldpath to newpath. If newpath already exists, Rename replaces it. OS-specific restrictions may apply when oldpath and newpath are in different directories. If there is an error, it will be of type *LinkError.

func Stat

func Stat(name string) (os.FileInfo, error)

Stat returns a FileInfo structure describing the named file. If there is an error, it will be of type *PathError.

func Symlink

func Symlink(oldname, newname string) error

Symlink creates newname as a symbolic link to oldname. If there is an error, it will be of type *LinkError.

func TempFile

func TempFile(dir, prefix string) (f *os.File, err error)

TempFile creates a temporary file which has already been deleted (on supported platforms)

func Walk

func Walk(root string, walkFn filepath.WalkFunc) error

Walk walks the file tree rooted at root, calling walkFn for each file or directory in the tree, including root. All errors that arise visiting files and directories are filtered by walkFn. The files are walked in lexical order, which makes the output deterministic but means that for very large directories Walk can be inefficient. Walk does not follow symbolic links.

Types

type File

type File interface {
	io.Reader
	io.Writer
	io.Closer

	Fd() uintptr
	Readdirnames(n int) ([]string, error)
	Readdir(int) ([]os.FileInfo, error)
	Seek(int64, int) (int64, error)
	Stat() (os.FileInfo, error)
}

File is an open file on a file system.

func Open

func Open(name string) (File, error)

Open opens a file for reading.