os

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
• Variables
• func Exit(code int)
• func Getpid() int
• func Getwd() (string, error)
• func IsExist(err error) bool
• func IsNotExist(err error) bool
• func IsPathSeparator(c uint8) bool
• func Mkdir(name string, perm FileMode) error
• func Readlink(name string) (string, error)
• func TempDir() string
• type File
  • func Create(name string) (*File, error)
  • func NewFile(fd uintptr, name string) *File
  • func Open(name string) (*File, error)
  • func OpenFile(name string, flag int, perm FileMode) (*File, error)
  • func (f *File) Close() error
  • func (f *File) Fd() uintptr
  • func (f *File) Read(b []byte) (n int, err error)
  • func (f *File) Readdir(n int) ([]FileInfo, error)
  • func (f *File) Readdirnames(n int) (names []string, err error)
  • func (f *File) Stat() (FileInfo, error)
  • func (f *File) Write(b []byte) (n int, err error)
• type FileInfo
  • func Lstat(name string) (FileInfo, error)
  • func Stat(name string) (FileInfo, error)
• type FileMode
  • func (m FileMode) IsDir() bool
• type PathError
  • func (e *PathError) Error() string

Constants

const (
	PathSeparator     = '/' // OS-specific path separator
	PathListSeparator = ':' // OS-specific path list separator
)

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

var (
	Stdin  = &File{0, "/dev/stdin"}
	Stdout = &File{1, "/dev/stdout"}
	Stderr = &File{2, "/dev/stderr"}
)

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

Functions

func Exit

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 Getpid

func Getpid() int

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

func Getwd

func Getwd() (string, error)

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

func IsExist

func IsExist(err error) bool

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

func IsNotExist

func IsNotExist(err error) bool

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

func IsPathSeparator

func IsPathSeparator(c uint8) bool

IsPathSeparator reports whether c is a directory separator character.

func Mkdir

func Mkdir(name string, perm FileMode) error

Mkdir is a stub, not yet implemented

func Readlink

func Readlink(name string) (string, error)

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

func TempDir

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

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

Create is a stub, passing through to the stub Open() call

func NewFile

func NewFile(fd uintptr, name string) *File

NewFile returns a new File with the given file descriptor and name.

func Open

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

Open is a super simple stub function (for now), only capable of opening stdin, stdout, and stderr

func OpenFile

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

OpenFile is a stub, passing through to the stub Open() call

func (*File) Close

func (f *File) Close() error

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

func (*File) Fd

func (f *File) Fd() uintptr

Fd returns the integer Unix file descriptor referencing the open file. The file descriptor is valid only until f.Close is called.

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) Readdir

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

Readdir is a stub, not yet implemented

func (*File) Readdirnames

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

Readdirnames is a stub, not yet implemented

func (*File) Stat

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

Stat is a stub, not yet implemented

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 FileInfo

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
	// 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

func Lstat(name string) (FileInfo, error)

Lstat is a stub, not yet implemented

func Stat

func Stat(name string) (FileInfo, error)

Stat is a stub, not yet implemented

type FileMode

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

func (m FileMode) IsDir() bool

IsDir is a stub, always returning false

type PathError

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

func (e *PathError) Error() string