file

Documentation

Index

• type File
• type FileSystem
• type ReadCloser
• type Reader
• type WriteCloser
• type Writer

Types

type File

type File interface {
	io.Reader
	io.Writer
	io.Seeker
	io.Closer
	io.ReaderAt
	Truncate(size int64) error
	Sync() error
}

type FileSystem

type FileSystem interface {
	// Open opens a file using specified flag.
	Open(name string, flag int) (File, error)

	// Lock locks a file for exclusive usage. If the file is locked by
	// someone else, failed with an error instead of blocking.
	Lock(name string) (io.Closer, error)

	// Exists returns true if the named file exists.
	Exists(name string) bool

	// MkdirAll creates a directory and all necessary parents.
	MkdirAll(path string) error

	// Lists returns all contents of the directory.
	List(dir string) ([]string, error)

	// Remove removes named file or directory.
	Remove(filename string) error

	// Rename renames(moves) oldpath to newpath. If newpath already exists,
	// Rename replaces it.
	Rename(oldpath, newpath string) error
}

FileSystem defines methods for hierarchical file storage.

var DefaultFileSystem FileSystem = osFileSystem{}

type ReadCloser

type ReadCloser interface {
	Reader
	io.Closer
}

type Reader

type Reader interface {
	io.Reader
	io.ReaderAt
	io.Seeker
}

type WriteCloser

type WriteCloser interface {
	Writer
	io.Closer
}

type Writer

type Writer interface {
	io.Writer
	io.Seeker
	Truncate(size int64) error
	Sync() error
}