diskusage

Documentation

Overview

Package diskusage is used to get platform specific file system usage information.

Index

• type DiskUsage
  • func Statfs(volumePath string) (DiskUsage, error)
  • func (du DiskUsage) AvailablePercent() float64
  • func (du DiskUsage) String() string

Types

type DiskUsage

type DiskUsage struct {
	// AvailableBytes is the total available bytes on file system to an unprivileged user.
	AvailableBytes uint64
	// SizeBytes is the total size of the file system in bytes.
	SizeBytes uint64
}

DiskUsage contains usage data and provides user-friendly access methods.

func Statfs

func Statfs(volumePath string) (DiskUsage, error)

Statfs returns file system statistics.

func (DiskUsage) AvailablePercent

func (du DiskUsage) AvailablePercent() float64

AvailablePercent returns the percentage (0.0-1.0) of the disk available to an unprivileged user see `man statfs` for how the underlying values are derived on your platform.

func (DiskUsage) String

func (du DiskUsage) String() string