fs

Documentation

Index

• func CreateFlockFile(dir string) (*os.File, error)
• func HardLinkFiles(srcDir, dstDir string) error
• func IsDirOrSymlink(fi os.FileInfo) bool
• func IsPathExist(path string) bool
• func IsTemporaryFileName(fn string) bool
• func MkdirAllFailIfExist(path string) error
• func MkdirAllIfNotExist(path string) error
• func MustClose(f *os.File)
• func MustFileSize(path string) uint64
• func MustGetFreeSpace(path string) uint64
• func MustRemoveAll(path string)
• func MustRemoveAllWithDoneCallback(path string, done func())
• func MustStopDirRemover()
• func MustSyncPath(path string)
• func MustWriteData(w io.Writer, data []byte)
• func ReadFullData(r io.Reader, data []byte) error
• func RemoveDirContents(dir string)
• func SymlinkRelative(srcPath, dstPath string) error
• func WriteFileAtomically(path string, data []byte) error
• type MustReadAtCloser
• type ReaderAt
  • func OpenReaderAt(path string) (*ReaderAt, error)
  • func (r *ReaderAt) MustClose()
  • func (r *ReaderAt) MustFadviseSequentialRead(prefetch bool)
  • func (r *ReaderAt) MustReadAt(p []byte, off int64)

Functions

func CreateFlockFile

func CreateFlockFile(dir string) (*os.File, error)

CreateFlockFile creates flock.lock file in the directory dir and returns the handler to the file.

func HardLinkFiles

func HardLinkFiles(srcDir, dstDir string) error

HardLinkFiles makes hard links for all the files from srcDir in dstDir.

func IsDirOrSymlink

func IsDirOrSymlink(fi os.FileInfo) bool

IsDirOrSymlink returns true if fi is directory or symlink.

func IsPathExist

func IsPathExist(path string) bool

IsPathExist returns whether the given path exists.

func IsTemporaryFileName

func IsTemporaryFileName(fn string) bool

IsTemporaryFileName returns true if fn matches temporary file name pattern from WriteFileAtomically.

func MkdirAllFailIfExist

func MkdirAllFailIfExist(path string) error

MkdirAllFailIfExist creates the given path dir if it isn't exist.

Returns error if path already exists.

func MkdirAllIfNotExist

func MkdirAllIfNotExist(path string) error

MkdirAllIfNotExist creates the given path dir if it isn't exist.

func MustClose

func MustClose(f *os.File)

MustClose must close the given file f.

func MustFileSize

func MustFileSize(path string) uint64

MustFileSize returns file size for the given path.

func MustGetFreeSpace

func MustGetFreeSpace(path string) uint64

MustGetFreeSpace returns free space for the given directory path.

func MustRemoveAll

func MustRemoveAll(path string)

MustRemoveAll removes path with all the contents.

It properly handles NFS issue https://github.com/VictoriaMetrics/VictoriaMetrics/issues/61 .

func MustRemoveAllWithDoneCallback

func MustRemoveAllWithDoneCallback(path string, done func())

MustRemoveAllWithDoneCallback removes path with all the contents.

done is called after the path is successfully removed.

done may be called after the function returns for NFS path. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/61.

func MustStopDirRemover

func MustStopDirRemover()

MustStopDirRemover must be called in the end of graceful shutdown in order to wait for removing the remaining directories from removeDirCh.

It is expected that nobody calls MustRemoveAll when MustStopDirRemover is called.

func MustSyncPath

func MustSyncPath(path string)

MustSyncPath syncs contents of the given path.

func MustWriteData

func MustWriteData(w io.Writer, data []byte)

MustWriteData writes data to w.

func ReadFullData

func ReadFullData(r io.Reader, data []byte) error

ReadFullData reads len(data) bytes from r.

func RemoveDirContents

func RemoveDirContents(dir string)

RemoveDirContents removes all the contents of the given dir if it exists.

It doesn't remove the dir itself, so the dir may be mounted to a separate partition.

func SymlinkRelative

func SymlinkRelative(srcPath, dstPath string) error

SymlinkRelative creates relative symlink for srcPath in dstPath.

func WriteFileAtomically

func WriteFileAtomically(path string, data []byte) error

WriteFileAtomically atomically writes data to the given file path.

WriteFileAtomically returns only after the file is fully written and synced to the underlying storage.

Types

type MustReadAtCloser

type MustReadAtCloser interface {
	// MustReadAt must read len(p) bytes from offset off to p.
	MustReadAt(p []byte, off int64)

	// MustClose must close the reader.
	MustClose()
}

MustReadAtCloser is rand-access read interface.

type ReaderAt

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

ReaderAt implements rand-access reader.

func OpenReaderAt

func OpenReaderAt(path string) (*ReaderAt, error)

OpenReaderAt opens ReaderAt for reading from filename.

MustClose must be called on the returned ReaderAt when it is no longer needed.

func (*ReaderAt) MustClose

func (r *ReaderAt) MustClose()

MustClose closes r.

func (*ReaderAt) MustFadviseSequentialRead

func (r *ReaderAt) MustFadviseSequentialRead(prefetch bool)

MustFadviseSequentialRead hints the OS that f is read mostly sequentially.

if prefetch is set, then the OS is hinted to prefetch f data.

func (*ReaderAt) MustReadAt

func (r *ReaderAt) MustReadAt(p []byte, off int64)

MustReadAt reads len(p) bytes at off from r.