files

package

v0.1.4 Latest Latest Go to latest Published: Mar 13, 2023 License: LGPL-2.1 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

files is a set of utility structs and methods for working with collections of files

This section is empty.

This section is empty.

This section is empty.

type Directory struct {
	Path  string
	Files []*File
	Hash  hash.Hash
}

Directory represents a collection of files and some metadata about them

func NewDirectory(path string) *Directory

NewDirectory returns a new Directory struct (it is not a mkdir equivalent)

func (d *Directory) Append(f *File) error

Append adds a File struct to the Directory's Files slice

func (d *Directory) GetHashString() string

GetHashString returns the hex-encoded string representation of the Directory's Hash

func (d *Directory) MarshalJSON() ([]byte, error)

MarshalJSON is a standard helper function for representing a Directory struct in JSON format

type File struct {
	Stats     *stat.Stat `json:"stats"`
	StatsHash string     `json:"statshash"`
}

File represents

func NewFile(fullpath, relpath string, fi fs.FileInfo) (*File, error)

NewFile returns a new File struct (it is not involved in the creation of files in the filesystem)

func (f *File) PopulateHash() error

PopulateHash calculates the checksum of the JSON representation of the Stats member struct and populates the StatsHash member