drive

package

v0.1.0 Latest Latest Go to latest Published: May 25, 2025 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/crumbyte/noxdir

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
Variables
func Explore(path string) error
type FileInfo
- func NewFileInfo(name string, data *unix.Stat_t) FileInfo
- func ReadDir(path string) ([]FileInfo, error)
type Info
type InoFilter
- func (inf *InoFilter) Add(inode uint64) bool
- func (inf *InoFilter) Reset()
type List
- func NewList() (*List, error)
type SortKey

Constants ¶

View Source

const NTFSSbMagic = 0x5346544e

Variables ¶

View Source

var InoFilterInstance = InoFilter{
	// contains filtered or unexported fields
}

Functions ¶

func Explore ¶

func Explore(path string) error

Types ¶

type FileInfo ¶

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

FileInfo defines a custom fs.FileInfo implementation for wrapping the results from the file info system calls.

func NewFileInfo ¶

func NewFileInfo(name string, data *unix.Stat_t) FileInfo

func ReadDir ¶

func ReadDir(path string) ([]FileInfo, error)

func (FileInfo) IsDir ¶

func (fi FileInfo) IsDir() bool

func (FileInfo) ModTime ¶

func (fi FileInfo) ModTime() int64

func (FileInfo) Mode ¶

func (fi FileInfo) Mode() os.FileMode

func (FileInfo) Name ¶

func (fi FileInfo) Name() string

func (FileInfo) Size ¶

func (fi FileInfo) Size() int64

func (FileInfo) Sys ¶

func (fi FileInfo) Sys() any

type Info ¶

type Info struct {
	Path        string  `json:"path"`
	Volume      string  `json:"volume"`
	FSName      string  `json:"fsName"`
	TotalBytes  uint64  `json:"total"`
	FreeBytes   uint64  `json:"free"`
	UsedBytes   uint64  `json:"used"`
	UsedPercent float64 `json:"usedPercent"`
}

Info contains information about a single drive/volume/mount. The data can be fetched using a corresponding operating system syscall against a target entry.

type InoFilter ¶ added in v0.1.0

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

InoFilter filters files by inode value, preventing the double calculation of the same space on the disk. The filter must be manually reset before each new volume scan.

func (*InoFilter) Add ¶ added in v0.1.0

func (inf *InoFilter) Add(inode uint64) bool

Add adds a new inode value to the filter. It returns a bool value depending on whether the inode already exists - "false", or adds it to the filter - "true".

func (*InoFilter) Reset ¶ added in v0.1.0

func (inf *InoFilter) Reset()

type List ¶

type List struct {
	TotalCapacity uint64
	TotalUsed     uint64
	TotalFree     uint64
	// contains filtered or unexported fields
}

func NewList ¶

func NewList() (*List, error)

func (*List) All ¶

func (l *List) All() map[string]*Info

func (*List) DriveInfo ¶

func (l *List) DriveInfo(path string) *Info

func (*List) Find ¶

func (l *List) Find(diskPath string) *Info

func (*List) Sort ¶

func (l *List) Sort(sk SortKey, desc bool) []*Info

type SortKey ¶

type SortKey string

const (
	TotalCap   SortKey = "t"
	TotalUsed  SortKey = "u"
	TotalFree  SortKey = "f"
	TotalUsedP SortKey = "g"
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL