portableOS

Documentation

Overview

Package portableOS contains global OS functions that can be overwritten to be used with other filesystems not supported by the os package, such as wasm.

Note to those implementing these functions: all function errors of certain types must match the following errors

"permission denied"
"file already exists"
"file does not exist"
"file already closed"

Index

• Variables
• type File
• type FileInfo
• type FileMode

Variables

var Create = func(name string) (File, error) {
	return os.Create(name)
}

Create creates or truncates the named file. If the file already exists, it is truncated. If the file does not exist, it is created with mode 0666 (before umask). If successful, methods on the returned File can be used for I/O; the associated file descriptor has mode os.O_RDWR.

var MkdirAll = func(path string, perm FileMode) error {
	return os.MkdirAll(path, os.FileMode(perm))
}

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

var Open = func(name string) (File, error) {
	return os.Open(name)
}

Open opens the named file for reading. If successful, methods on the returned file can be used for reading; the associated file descriptor has mode os.O_RDONLY.

var Remove = os.Remove

Remove removes the named file or directory.

var RemoveAll = os.RemoveAll

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). If there is an error, it will be of type *PathError.

var Stat = func(name string) (FileInfo, error) {
	return os.Stat(name)
}

Stat returns a FileInfo describing the named file.

Types

type File

type File interface {
	// Close closes the File, rendering it unusable for I/O.
	// On files that support SetDeadline, any pending I/O operations will
	// be canceled and return immediately with an ErrClosed error.
	// Close will return an error if it has already been called.
	Close() error

	// Name returns the name of the file as presented to Open.
	Name() string

	// Read reads up to len(b) bytes from the File and stores them in b.
	// It returns the number of bytes read and any error encountered.
	// At end of file, Read returns 0, io.EOF.
	Read(b []byte) (n int, err error)

	// ReadAt reads len(b) bytes from the File starting at byte offset off.
	// It returns the number of bytes read and the error, if any.
	// ReadAt always returns a non-nil error when n < len(b).
	// At end of file, that error is io.EOF.
	ReadAt(b []byte, off int64) (n int, err error)

	// Seek sets the offset for the next Read or Write on file to offset,
	// interpreted according to whence: 0 means relative to the origin of the
	// file, 1 means relative to the current offset, and 2 means relative to the
	// end. It returns the new offset and an error, if any. The behavior of Seek
	// on a file opened with os.O_APPEND is not specified.
	//
	// If f is a directory, the behavior of Seek varies by operating system; you
	// can seek to the beginning of the directory on Unix-like operating
	// systems, but not on Windows.
	Seek(offset int64, whence int) (ret int64, err error)

	// Sync commits the current contents of the file to stable storage.
	// Typically, this means flushing the file system's in-memory copy
	// of recently written data to disk.
	Sync() error

	// Write writes len(b) bytes from b to the File.
	// It returns the number of bytes written and an error, if any.
	// Write returns a non-nil error when n != len(b).
	Write(b []byte) (n int, err error)
}

File represents an open file descriptor. It contains a subset of the methods on os.File that are used in this repository.

type FileInfo

type FileInfo interface {
	// Name returns the base name of the file.
	Name() string

	// Size returns the length in bytes for regular files; system-dependent for
	// others.
	Size() int64

	// IsDir reports whether m describes a directory.
	// That is, it tests for the ModeDir bit being set in m.
	IsDir() bool
}

A FileInfo describes a file and is returned by Stat. It contains a subset of the methods on os.FileInfo that are used in this repository.

type FileMode

type FileMode uint32

A FileMode represents a file's mode and permission bits. The bits have the same definition on all systems, so that information about files can be moved from one system to another portably. Not all bits apply to all systems. The only required bit is os.ModeDir for directories. See os.FileMode for all possible values.