diskusage

Documentation

Overview

Package diskusage provides a cross platform version of the statfs system call to read disk space usage.

Index

• Variables
• type Info
  • func New(dir string) (info Info, err error)

Variables

var ErrUnsupported = errors.New("disk usage unsupported on this platform")

ErrUnsupported is returned if this platform doesn't support disk usage.

Types

type Info

type Info struct {
	Free      uint64 // total free bytes
	Available uint64 // free bytes available to the current user
	Total     uint64 // total bytes on disk
}

Info is returned from New showing details about the disk.

func New

func New(dir string) (info Info, err error)

New returns the disk status for dir.

May return Unsupported error if it doesn't work on this platform.