fsutil

package

v0.0.0-...-1b33b2a Latest Latest Go to latest Published: Mar 5, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func IsDirAndWritable(path string) error

IsDirAndWritable checks a given path is directory and writable

func IsDirReadWritable(dir string) error

IsDirReadWritable check if the dir is writable and readable by cdc server

func IsDirWritable(dir string) error

IsDirWritable checks if a dir is writable, return error nil means it is writable

type DiskInfo struct {
	All             uint64
	Used            uint64
	Free            uint64
	Avail           uint64
	AvailPercentage float32
}

DiskInfo present the disk amount information, in gb

func GetDiskInfo(dir string) (*DiskInfo, error)

GetDiskInfo return the disk space information of the given directory the caller should guarantee that dir exist

func (d *DiskInfo) String() string

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

FileLock represents a file lock created by `flock`. For more on the system call `flock`, read: https://linux.die.net/man/2/flock

func NewFileLock(filePath string) (*FileLock, error)

NewFileLock creates a new file lock on the file described in filePath.

func (fl *FileLock) Close() error

Close closes the underlying file. NOTE: this function will unlock the lock as well.

func (fl *FileLock) IsLocked() (bool, error)

IsLocked checks whether the file is currently locked

func (fl *FileLock) Lock() error

Lock places a lock on the file

func (fl *FileLock) Unlock() error

Unlock unlocks the file lock