diskusage

Documentation

Overview

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

Index

• type DiskUsage
  • func NewDiskUsage(volumePath string) *DiskUsage
  • func (du *DiskUsage) Available() uint64
  • func (du *DiskUsage) Free() uint64
  • func (du *DiskUsage) Size() uint64
  • func (du *DiskUsage) Usage() float32
  • func (du *DiskUsage) Used() uint64

Types

type DiskUsage

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

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

func NewDiskUsage

func NewDiskUsage(volumePath string) *DiskUsage

NewDiskUsage returns an object holding the disk usage of volumePath or nil in case of error (invalid path, etc).

func (*DiskUsage) Available

func (du *DiskUsage) Available() uint64

Available return total available bytes on file system to an unprivileged user.

func (*DiskUsage) Free

func (du *DiskUsage) Free() uint64

Free returns total free bytes on file system.

func (*DiskUsage) Size

func (du *DiskUsage) Size() uint64

Size returns total size of the file system.

func (*DiskUsage) Usage

func (du *DiskUsage) Usage() float32

Usage returns percentage of use on the file system.

func (*DiskUsage) Used

func (du *DiskUsage) Used() uint64

Used returns total bytes used in file system.