Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TopFilesInstance = EntrySizeHeap{/* contains filtered or unexported fields */} TopDirsInstance = TopDirs{EntrySizeHeap: EntrySizeHeap{/* contains filtered or unexported fields */}} )
Functions ¶
This section is empty.
Types ¶
type Entry ¶
type Entry struct {
// Path contains the full path to the file or directory represented as an
// instance of the entry.
Path string
// Child contains a list of all child instances including both files and
// directories. If the current Entry instance represents a file, this
// property will always be nil.
Child []*Entry
// ModTime contains the last modification time of the entry.
ModTime int64
// Size contains a total tail in bytes including sizes of all child entries.
Size int64
// LocalDirs contain the number of directories within the current entry. This
// property will always be zero if the current instance represents a file.
LocalDirs uint64
// LocalFiles contain the number of files within the current entry. This property
// will always be zero if the current instance represents a file.
LocalFiles uint64
// TotalDirs contains the total number of directories within the current
// entry, including directories within the child entries. This property will
// always be zero if the current instance represents a file.
TotalDirs uint64
// TotalFiles contains the total number of files within the current entry,
// including files within the child entries. This property will always be
// zero if the current instance represents a file.
TotalFiles uint64
// IsDir defines whether the current instance represents a dir or a file.
IsDir bool
// contains filtered or unexported fields
}
Entry contains the information about a single directory or a file instance within the file system. If the entry represents a directory instance, it has access to its child elements.
func NewDirEntry ¶
func (*Entry) AddChild ¶
AddChild adds the provided *Entry instance to a list of child entries. The counters will be updated respectively depending on the type of child entry.
func (*Entry) Entries ¶ added in v0.1.0
Entries returns an iterator for the current node's child elements. Depending on the provided argument, the iterator yields either directories or files.
type EntrySizeHeap ¶ added in v0.1.0
type EntrySizeHeap struct {
// contains filtered or unexported fields
}
EntrySizeHeap contains a list of the biggest dirs or files found on a specific drive/volume. It implements the heap.Interface, hence it persists entries sorted by their sizes. The EntrySizeHeap could contain up to n files, where n is defined when creating a new heap instance.
func (*EntrySizeHeap) Len ¶ added in v0.1.0
func (esh *EntrySizeHeap) Len() int
func (*EntrySizeHeap) Less ¶ added in v0.1.0
func (esh *EntrySizeHeap) Less(i, j int) bool
func (*EntrySizeHeap) Pop ¶ added in v0.1.0
func (esh *EntrySizeHeap) Pop() (v any)
func (*EntrySizeHeap) Push ¶ added in v0.1.0
func (esh *EntrySizeHeap) Push(v any)
func (*EntrySizeHeap) PushSafe ¶ added in v0.1.0
func (esh *EntrySizeHeap) PushSafe(e *Entry)
PushSafe provides a thread-safe method for adding elements to the heap. On each call, it will check the current number of items and pop the oldest.
func (*EntrySizeHeap) Reset ¶ added in v0.1.0
func (esh *EntrySizeHeap) Reset()
func (*EntrySizeHeap) Swap ¶ added in v0.1.0
func (esh *EntrySizeHeap) Swap(i, j int)
type TopDirs ¶ added in v0.1.0
type TopDirs struct {
EntrySizeHeap
}
type Tree ¶ added in v0.1.0
type Tree struct {
// contains filtered or unexported fields
}
Tree provides a set of method for building and traversing the *Entry tree.
func (*Tree) CalculateSize ¶ added in v0.1.0
func (t *Tree) CalculateSize()
CalculateSize calculates the total number of directories and files, including ones within child entries, and the total tail of the current entry instance. This function call will recursively calculate the sizes of child entries. The final [Entry.Size] field will be a sum of all nested files sizes. If the current entry represents a file, only its own tail will be returned.
func (*Tree) Traverse ¶ added in v0.1.0
Traverse traverses the current root entry instance for all internal files, and directories and builds the corresponding tree using a BFS approach. The total traverse duration depends on the directory's structure depth.
The traverse process only builds the tree structure of child entries and does not calculate the final values for total tail and number of child directories and files. To do this, the Tree.CalculateSize must be called during or after the traverse finishes the execution. In the first case, the numbers will not be accurate but can be used to display the progress of the traversing process gradually.
func (*Tree) TraverseAsync ¶ added in v0.1.0
type TreeOpt ¶ added in v0.1.0
type TreeOpt func(*Tree)
TreeOpt defines a custom type for configuring a *Tree instance.
func WithExclude ¶ added in v0.1.0
WithExclude allows setting a list of directory names that must be excluded from the traversal during the tree build-up process. The directory name can represent an absolute path or just a part of the name. In the last case, all directories that contain this name will be excluded. For example, the following path "dir/sub_dir/inner/other" and adding the name "sub" for exclusion will completely remove the "dir/sub_dir" directory from traversal. To avoid that, use a more specific path, e.g., "dir/sub/".
Source Files