// Name returns the name of the file as presented to Open. // // It is safe to call Name after [Close]. func (f *File) Name() string { … } var Stdin … var Stdout … var Stderr … const O_RDONLY … const O_WRONLY … const O_RDWR … const O_APPEND … const O_CREATE … const O_EXCL … const O_SYNC … const O_TRUNC … const SEEK_SET … const SEEK_CUR … const SEEK_END … type LinkError … func (e *LinkError) Error() string { … } func (e *LinkError) Unwrap() error { … } // 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. func (f *File) 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. func (f *File) ReadAt(b []byte, off int64) (n int, err error) { … } // ReadFrom implements io.ReaderFrom. func (f *File) ReadFrom(r io.Reader) (n int64, err error) { … } type noReadFrom … // ReadFrom hides another ReadFrom method. // It should never be called. func (noReadFrom) ReadFrom(io.Reader) (int64, error) { … } type fileWithoutReadFrom … func genericReadFrom(f *File, r io.Reader) (int64, 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). func (f *File) Write(b []byte) (n int, err error) { … } var errWriteAtInAppendMode … // WriteAt writes len(b) bytes to the File starting at byte offset off. // It returns the number of bytes written and an error, if any. // WriteAt returns a non-nil error when n != len(b). // // If file was opened with the O_APPEND flag, WriteAt returns an error. func (f *File) WriteAt(b []byte, off int64) (n int, err error) { … } // WriteTo implements io.WriterTo. func (f *File) WriteTo(w io.Writer) (n int64, err error) { … } type noWriteTo … // WriteTo hides another WriteTo method. // It should never be called. func (noWriteTo) WriteTo(io.Writer) (int64, error) { … } type fileWithoutWriteTo … func genericWriteTo(f *File, w io.Writer) (int64, 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 O_APPEND is not specified. func (f *File) Seek(offset int64, whence int) (ret int64, err error) { … } // WriteString is like Write, but writes the contents of string s rather than // a slice of bytes. func (f *File) WriteString(s string) (n int, err error) { … } // Mkdir creates a new directory with the specified name and permission // bits (before umask). // If there is an error, it will be of type *PathError. func Mkdir(name string, perm FileMode) error { … } // setStickyBit adds ModeSticky to the permission bits of path, non atomic. func setStickyBit(name string) error { … } // Chdir changes the current working directory to the named directory. // If there is an error, it will be of type *PathError. func Chdir(dir string) error { … } // 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 O_RDONLY. // If there is an error, it will be of type *PathError. func Open(name string) (*File, error) { … } // 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 0o666 // (before umask). If successful, methods on the returned File can // be used for I/O; the associated file descriptor has mode O_RDWR. // The directory containing the file must already exist. // If there is an error, it will be of type *PathError. func Create(name string) (*File, error) { … } // OpenFile is the generalized open call; most users will use Open // or Create instead. It opens the named file with specified flag // (O_RDONLY etc.). If the file does not exist, and the O_CREATE flag // is passed, it is created with mode perm (before umask); // the containing directory must exist. If successful, // methods on the returned File can be used for I/O. // If there is an error, it will be of type *PathError. func OpenFile(name string, flag int, perm FileMode) (*File, error) { … } // openDir opens a file which is assumed to be a directory. As such, it skips // the syscalls that make the file descriptor non-blocking as these take time // and will fail on file descriptors for directories. func openDir(name string) (*File, error) { … } var lstat … // Rename renames (moves) oldpath to newpath. // If newpath already exists and is not a directory, Rename replaces it. // If newpath already exists and is a directory, Rename returns an error. // OS-specific restrictions may apply when oldpath and newpath are in different directories. // Even within the same directory, on non-Unix platforms Rename is not an atomic operation. // If there is an error, it will be of type *LinkError. func Rename(oldpath, newpath string) error { … } // Readlink returns the destination of the named symbolic link. // If there is an error, it will be of type *PathError. // // If the link destination is relative, Readlink returns the relative path // without resolving it to an absolute one. func Readlink(name string) (string, error) { … } // Many functions in package syscall return a count of -1 instead of 0. // Using fixCount(call()) instead of call() corrects the count. func fixCount(n int, err error) (int, error) { … } var checkWrapErr … // wrapErr wraps an error that occurred during an operation on an open file. // It passes io.EOF through unchanged, otherwise converts // poll.ErrFileClosing to ErrClosed and wraps the error in a PathError. func (f *File) wrapErr(op string, err error) error { … } // TempDir returns the default directory to use for temporary files. // // On Unix systems, it returns $TMPDIR if non-empty, else /tmp. // On Windows, it uses GetTempPath, returning the first non-empty // value from %TMP%, %TEMP%, %USERPROFILE%, or the Windows directory. // On Plan 9, it returns /tmp. // // The directory is neither guaranteed to exist nor have accessible // permissions. func TempDir() string { … } // UserCacheDir returns the default root directory to use for user-specific // cached data. Users should create their own application-specific subdirectory // within this one and use that. // // On Unix systems, it returns $XDG_CACHE_HOME as specified by // https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html if // non-empty, else $HOME/.cache. // On Darwin, it returns $HOME/Library/Caches. // On Windows, it returns %LocalAppData%. // On Plan 9, it returns $home/lib/cache. // // If the location cannot be determined (for example, $HOME is not defined) or // the path in $XDG_CACHE_HOME is relative, then it will return an error. func UserCacheDir() (string, error) { … } // UserConfigDir returns the default root directory to use for user-specific // configuration data. Users should create their own application-specific // subdirectory within this one and use that. // // On Unix systems, it returns $XDG_CONFIG_HOME as specified by // https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html if // non-empty, else $HOME/.config. // On Darwin, it returns $HOME/Library/Application Support. // On Windows, it returns %AppData%. // On Plan 9, it returns $home/lib. // // If the location cannot be determined (for example, $HOME is not defined) or // the path in $XDG_CONFIG_HOME is relative, then it will return an error. func UserConfigDir() (string, error) { … } // UserHomeDir returns the current user's home directory. // // On Unix, including macOS, it returns the $HOME environment variable. // On Windows, it returns %USERPROFILE%. // On Plan 9, it returns the $home environment variable. // // If the expected variable is not set in the environment, UserHomeDir // returns either a platform-specific default value or a non-nil error. func UserHomeDir() (string, error) { … } // Chmod changes the mode of the named file to mode. // If the file is a symbolic link, it changes the mode of the link's target. // If there is an error, it will be of type *PathError. // // A different subset of the mode bits are used, depending on the // operating system. // // On Unix, the mode's permission bits, ModeSetuid, ModeSetgid, and // ModeSticky are used. // // On Windows, only the 0o200 bit (owner writable) of mode is used; it // controls whether the file's read-only attribute is set or cleared. // The other bits are currently unused. For compatibility with Go 1.12 // and earlier, use a non-zero mode. Use mode 0o400 for a read-only // file and 0o600 for a readable+writable file. // // On Plan 9, the mode's permission bits, ModeAppend, ModeExclusive, // and ModeTemporary are used. func Chmod(name string, mode FileMode) error { … } // Chmod changes the mode of the file to mode. // If there is an error, it will be of type *PathError. func (f *File) Chmod(mode FileMode) error { … } // SetDeadline sets the read and write deadlines for a File. // It is equivalent to calling both SetReadDeadline and SetWriteDeadline. // // Only some kinds of files support setting a deadline. Calls to SetDeadline // for files that do not support deadlines will return ErrNoDeadline. // On most systems ordinary files do not support deadlines, but pipes do. // // A deadline is an absolute time after which I/O operations fail with an // error instead of blocking. The deadline applies to all future and pending // I/O, not just the immediately following call to Read or Write. // After a deadline has been exceeded, the connection can be refreshed // by setting a deadline in the future. // // If the deadline is exceeded a call to Read or Write or to other I/O // methods will return an error that wraps ErrDeadlineExceeded. // This can be tested using errors.Is(err, os.ErrDeadlineExceeded). // That error implements the Timeout method, and calling the Timeout // method will return true, but there are other possible errors for which // the Timeout will return true even if the deadline has not been exceeded. // // An idle timeout can be implemented by repeatedly extending // the deadline after successful Read or Write calls. // // A zero value for t means I/O operations will not time out. func (f *File) SetDeadline(t time.Time) error { … } // SetReadDeadline sets the deadline for future Read calls and any // currently-blocked Read call. // A zero value for t means Read will not time out. // Not all files support setting deadlines; see SetDeadline. func (f *File) SetReadDeadline(t time.Time) error { … } // SetWriteDeadline sets the deadline for any future Write calls and any // currently-blocked Write call. // Even if Write times out, it may return n > 0, indicating that // some of the data was successfully written. // A zero value for t means Write will not time out. // Not all files support setting deadlines; see SetDeadline. func (f *File) SetWriteDeadline(t time.Time) error { … } // SyscallConn returns a raw file. // This implements the syscall.Conn interface. func (f *File) SyscallConn() (syscall.RawConn, error) { … } // DirFS returns a file system (an fs.FS) for the tree of files rooted at the directory dir. // // Note that DirFS("/prefix") only guarantees that the Open calls it makes to the // operating system will begin with "/prefix": DirFS("/prefix").Open("file") is the // same as os.Open("/prefix/file"). So if /prefix/file is a symbolic link pointing outside // the /prefix tree, then using DirFS does not stop the access any more than using // os.Open does. Additionally, the root of the fs.FS returned for a relative path, // DirFS("prefix"), will be affected by later calls to Chdir. DirFS is therefore not // a general substitute for a chroot-style security mechanism when the directory tree // contains arbitrary content. // // The directory dir must not be "". // // The result implements [io/fs.StatFS], [io/fs.ReadFileFS] and // [io/fs.ReadDirFS]. func DirFS(dir string) fs.FS { … } type dirFS … func (dir dirFS) Open(name string) (fs.File, error) { … } // The ReadFile method calls the [ReadFile] function for the file // with the given name in the directory. The function provides // robust handling for small files and special file systems. // Through this method, dirFS implements [io/fs.ReadFileFS]. func (dir dirFS) ReadFile(name string) ([]byte, error) { … } // ReadDir reads the named directory, returning all its directory entries sorted // by filename. Through this method, dirFS implements [io/fs.ReadDirFS]. func (dir dirFS) ReadDir(name string) ([]DirEntry, error) { … } func (dir dirFS) Stat(name string) (fs.FileInfo, error) { … } // join returns the path for name in dir. func (dir dirFS) join(name string) (string, error) { … } // ReadFile reads the named file and returns the contents. // A successful call returns err == nil, not err == EOF. // Because ReadFile reads the whole file, it does not treat an EOF from Read // as an error to be reported. func ReadFile(name string) ([]byte, error) { … } // WriteFile writes data to the named file, creating it if necessary. // If the file does not exist, WriteFile creates it with permissions perm (before umask); // otherwise WriteFile truncates it before writing, without changing permissions. // Since WriteFile requires multiple system calls to complete, a failure mid-operation // can leave the file in a partially written state. func WriteFile(name string, data []byte, perm FileMode) error { … }
Codebase Browser
go