os

package
v0.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 5, 2021 License: BSD-3-Clause Imports: 3 Imported by: 0

Documentation

Overview

Package os implements a subset of the Go "os" package. See https://godoc.org/os for details.

Note that the current implementation is blocking. This limitation should be removed in a future version.

Package os implements a subset of the Go "os" package. See https://godoc.org/os for details.

Note that the current implementation is blocking. This limitation should be removed in a future version.

Index

Constants

View Source 
const (
	PathSeparator     = '/' // OS-specific path separator
	PathListSeparator = ':' // OS-specific path list separator
)
View Source 
const (
	O_RDONLY int = 1
	O_WRONLY int = 2
	O_RDWR   int = 4
	O_APPEND int = 8
	O_CREATE int = 16
	O_EXCL   int = 32
	O_SYNC   int = 64
	O_TRUNC  int = 128
)

Stub constants

Variables

View Source 
var (
	ErrInvalid    = errors.New("invalid argument")
	ErrPermission = errors.New("permission denied")
	ErrClosed     = errors.New("file already closed")

	// Portable analogs of some common system call errors.
	// Note that these are exported for use in the Filesystem interface.
	ErrUnsupported    = errors.New("operation not supported")
	ErrNotImplemented = errors.New("operation not implemented")
	ErrNotExist       = errors.New("file not found")
	ErrExist          = errors.New("file exists")
)
View Source 
var (
	Stdin  = &File{unixFileHandle(0), "/dev/stdin"}
	Stdout = &File{unixFileHandle(1), "/dev/stdout"}
	Stderr = &File{unixFileHandle(2), "/dev/stderr"}
)

Stdin, Stdout, and Stderr are open Files pointing to the standard input, standard output, and standard error file descriptors.

View Source 
var Args []string

Args hold the command-line arguments, starting with the program name.

Functions

func Exit added in v0.7.0 

func Exit(code int)

Exit causes the current program to exit with the given status code. Conventionally, code zero indicates success, non-zero an error. The program terminates immediately; deferred functions are not run.

func Getenv added in v0.14.0 

func Getenv(key string) string

func Getpid added in v0.7.0 

func Getpid() int

Getpid is a stub (for now), always returning 1

func Getwd added in v0.7.0 

func Getwd() (string, error)

Getwd is a stub (for now), always returning an empty string

func Hostname added in v0.14.0 

func Hostname() (name string, err error)

func IsExist added in v0.7.0 

func IsExist(err error) bool

IsExist is a stub (for now), always returning false

func IsNotExist added in v0.7.0 

func IsNotExist(err error) bool

IsNotExist is a stub (for now), always returning false

func IsPathSeparator added in v0.7.0 

func IsPathSeparator(c uint8) bool

IsPathSeparator reports whether c is a directory separator character.

func IsPermission added in v0.14.0 

func IsPermission(err error) bool

func LookupEnv added in v0.17.0 

func LookupEnv(key string) (string, bool)

func Mkdir added in v0.7.0 

func Mkdir(path string, perm FileMode) error

Mkdir creates a directory. If the operation fails, it will return an error of type *PathError.

func Mount added in v0.14.0 

func Mount(prefix string, filesystem Filesystem)

Mount mounts the given filesystem in the filesystem abstraction layer of the os package. It is not possible to unmount filesystems. Filesystems added later will override earlier filesystems.

The provided prefix must start and end with a forward slash. This is true for the root directory ("/") for example.

func NewSyscallError added in v0.14.0 

func NewSyscallError(syscall string, err error) error
func Readlink(name string) (string, error)

Readlink is a stub (for now), always returning the string it was given

func Remove added in v0.14.0 

func Remove(path string) error

Remove removes a file or (empty) directory. If the operation fails, it will return an error of type *PathError.

func TempDir added in v0.7.0 

func TempDir() string

TempDir is a stub (for now), always returning the string "/tmp"

Types

type File 

type File struct {
	// contains filtered or unexported fields
}

File represents an open file descriptor.

func Create added in v0.7.0 

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

Create creates the named file, overwriting it if it already exists.

func Open added in v0.7.0 

func Open(name string) (*File, error)

Open opens the file named for reading.

func OpenFile added in v0.7.0 

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

OpenFile opens the named file. If the operation fails, the returned error will be of type *PathError.

func (*File) Close 

func (f *File) Close() (err error)

Close closes the File, rendering it unusable for I/O.

func (*File) Fd 

func (f *File) Fd() uintptr

Fd returns the file handle referencing the open file.

func (*File) Name added in v0.14.0 

func (f *File) Name() string

Name returns the name of the file with which it was opened.

func (*File) Read 

func (f *File) Read(b []byte) (n int, err error)

Read reads up to len(b) bytes from the File. It returns the number of bytes read and any error encountered. At end of file, Read returns 0, io.EOF.

func (*File) ReadAt added in v0.14.0 

func (f *File) ReadAt(b []byte, off int64) (n int, err error)

func (*File) Readdir added in v0.7.0 

func (f *File) Readdir(n int) ([]FileInfo, error)

Readdir is a stub, not yet implemented

func (*File) Readdirnames added in v0.7.0 

func (f *File) Readdirnames(n int) (names []string, err error)

Readdirnames is a stub, not yet implemented

func (*File) Stat added in v0.7.0 

func (f *File) Stat() (FileInfo, error)

Stat is a stub, not yet implemented

func (*File) Sync added in v0.14.0 

func (f *File) Sync() error

Sync is a stub, not yet implemented

func (*File) SyscallConn added in v0.14.0 

func (f *File) SyscallConn() (syscall.RawConn, error)

func (*File) Write 

func (f *File) Write(b []byte) (n int, err error)

Write writes len(b) bytes 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).

type FileHandle added in v0.14.0 

type FileHandle interface {
	// Read reads up to len(b) bytes from the file.
	Read(b []byte) (n int, err error)

	// Write writes up to len(b) bytes to the file.
	Write(b []byte) (n int, err error)

	// Close closes the file, making it unusable for further writes.
	Close() (err error)
}

FileHandle is an interface that should be implemented by filesystems implementing the Filesystem interface.

WARNING: this interface is not finalized and may change in a future version.

type FileInfo added in v0.7.0 

type FileInfo interface {
	Name() string   // base name of the file
	Size() int64    // length in bytes for regular files; system-dependent for others
	Mode() FileMode // file mode bits
	// TODO ModTime() time.Time // modification time
	IsDir() bool      // abbreviation for Mode().IsDir()
	Sys() interface{} // underlying data source (can return nil)
}

A FileInfo describes a file and is returned by Stat and Lstat.

func Lstat added in v0.7.0 

func Lstat(name string) (FileInfo, error)

Lstat is a stub, not yet implemented

func Stat added in v0.7.0 

func Stat(name string) (FileInfo, error)

Stat is a stub, not yet implemented

type FileMode added in v0.7.0 

type FileMode uint32
const (
	// The single letters are the abbreviations used by the String method's formatting.
	ModeDir        FileMode = 1 << (32 - 1 - iota) // d: is a directory
	ModeAppend                                     // a: append-only
	ModeExclusive                                  // l: exclusive use
	ModeTemporary                                  // T: temporary file; Plan 9 only
	ModeSymlink                                    // L: symbolic link
	ModeDevice                                     // D: device file
	ModeNamedPipe                                  // p: named pipe (FIFO)
	ModeSocket                                     // S: Unix domain socket
	ModeSetuid                                     // u: setuid
	ModeSetgid                                     // g: setgid
	ModeCharDevice                                 // c: Unix character device, when ModeDevice is set
	ModeSticky                                     // t: sticky
	ModeIrregular                                  // ?: non-regular file; nothing else is known about this file

	// Mask for the type bits. For regular files, none will be set.
	ModeType = ModeDir | ModeSymlink | ModeNamedPipe | ModeSocket | ModeDevice | ModeCharDevice | ModeIrregular

	ModePerm FileMode = 0777 // Unix permission bits
)

Mode constants, copied from the mainline Go source https://github.com/golang/go/blob/4ce6a8e89668b87dce67e2f55802903d6eb9110a/src/os/types.go#L35-L63

func (FileMode) IsDir added in v0.7.0 

func (m FileMode) IsDir() bool

IsDir is a stub, always returning false

type Filesystem added in v0.14.0 

type Filesystem interface {
	// OpenFile opens the named file.
	OpenFile(name string, flag int, perm FileMode) (FileHandle, error)

	// Mkdir creates a new directoy with the specified permission (before
	// umask). Some filesystems may not support directories or permissions.
	Mkdir(name string, perm FileMode) error

	// Remove removes the named file or (empty) directory.
	Remove(name string) error
}

Filesystem provides an interface for generic filesystem drivers mounted in the os package. The errors returned must be one of the os.Err* errors, or a custom error if one doesn't exist. It should not be a *PathError because errors will be wrapped with a *PathError by the filesystem abstraction.

WARNING: this interface is not finalized and may change in a future version.

type PathError added in v0.7.0 

type PathError struct {
	Op   string
	Path string
	Err  error
}

PathError records an error and the operation and file path that caused it.

func (*PathError) Error added in v0.7.0 

func (e *PathError) Error() string

type Signal added in v0.14.0 

type Signal interface {
	String() string
	Signal() // to distinguish from other Stringers
}

type SyscallError added in v0.14.0 

type SyscallError struct {
	Syscall string
	Err     error
}

SyscallError records an error from a specific system call.

func (*SyscallError) Error added in v0.14.0 

func (e *SyscallError) Error() string

func (*SyscallError) Unwrap added in v0.14.0 

func (e *SyscallError) Unwrap() error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.