osx

Documentation

Index

• Variables
• func Close(c io.Closer)
• func CreateFile(name string, perm os.FileMode) (*os.File, error)
• func ExistEnv(key string) bool
• func Exists(path string, checks ...func(os.FileInfo) bool) bool
• func ExistsDevice(path string) bool
• func ExistsDir(path string) bool
• func ExistsFile(path string) bool
• func ExistsLink(path string) bool
• func ExistsSocket(path string) bool
• func ExpandEnv(key string, def ...string) string
• func Getenv(key string, def ...string) string
• func InlineTilde(path string) string
• func Open(path string) (*os.File, error)
• func OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)
• func UserHomeDir() string
• func WriteFile(name string, data []byte, perm os.FileMode) error
• type MmapFile
  • func OpenMmapFile(path string) (*MmapFile, error)
  • func OpenMmapFileWithSize(path string, size int) (*MmapFile, error)
  • func (f *MmapFile) Bytes() []byte
  • func (f *MmapFile) Close() error
  • func (f *MmapFile) Len() int64
  • func (f *MmapFile) ReadAt(p []byte, off int64) (_ int, err error)

Variables

var ErrPageFault = errors.New("page fault occurred while reading from memory map")

Functions

func Close

func Close(c io.Closer)

Close closes the given io.Closer without error.

func CreateFile

func CreateFile(name string, perm os.FileMode) (*os.File, error)

CreateFile is similar to os.Create but supports ~ as the home directory, and also supports the parent directory creation.

func ExistEnv

func ExistEnv(key string) bool

ExistEnv checks if the environment variable named by the key exists.

func Exists

func Exists(path string, checks ...func(os.FileInfo) bool) bool

Exists checks if the given path exists.

func ExistsDevice

func ExistsDevice(path string) bool

ExistsDevice checks if the given path exists and is a device.

func ExistsDir

func ExistsDir(path string) bool

ExistsDir checks if the given path exists and is a directory.

func ExistsFile

func ExistsFile(path string) bool

ExistsFile checks if the given path exists and is a regular file.

func ExistsLink

func ExistsLink(path string) bool

ExistsLink checks if the given path exists and is a symbolic link.

func ExistsSocket

func ExistsSocket(path string) bool

ExistsSocket checks if the given path exists and is a socket.

func ExpandEnv

func ExpandEnv(key string, def ...string) string

ExpandEnv is similar to Getenv, but replaces ${var} or $var in the result.

func Getenv

func Getenv(key string, def ...string) string

Getenv retrieves the value of the environment variable named by the key. It returns the default, which will be empty if the variable is not present. To distinguish between an empty value and an unset value, use LookupEnv.

func InlineTilde

func InlineTilde(path string) string

InlineTilde replaces the leading ~ with the home directory.

func Open

func Open(path string) (*os.File, error)

Open is similar to os.Open but supports ~ as the home directory.

func OpenFile

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

OpenFile is similar to os.OpenFile but supports ~ as the home directory, and also supports the parent directory creation.

func UserHomeDir

func UserHomeDir() string

UserHomeDir is similar to os.UserHomeDir, but returns the temp dir if the home dir is not found.

func WriteFile

func WriteFile(name string, data []byte, perm os.FileMode) error

WriteFile is similar to os.WriteFile but supports ~ as the home directory, and also supports the parent directory creation.

Types

type MmapFile

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

func OpenMmapFile

func OpenMmapFile(path string) (*MmapFile, error)

func OpenMmapFileWithSize

func OpenMmapFileWithSize(path string, size int) (*MmapFile, error)

func (*MmapFile) Bytes

func (f *MmapFile) Bytes() []byte

func (*MmapFile) Close

func (f *MmapFile) Close() error

func (*MmapFile) Len

func (f *MmapFile) Len() int64

func (*MmapFile) ReadAt

func (f *MmapFile) ReadAt(p []byte, off int64) (_ int, err error)