filepath_summary

Documentation

Index

• type DirSummary
  • func NewDirSummary(baseDir string, flattenedFileSummaries []*FileSummary) *DirSummary
• type FileSummary
  • func NewFileSummary(relativePath string, modTime time.Time, checksum *checksums.ChecksumResult) *FileSummary
  • func (f *FileSummary) HaveSamePath(other *FileSummary) bool
• type Service
  • func New(checksumsSvc checksums.Service) Service

Types

type DirSummary

type DirSummary struct {
	BaseDir                string
	FlattenedFileSummaries []*FileSummary
}

DirSummary holds the summary used for synchronizing across

func NewDirSummary

func NewDirSummary(baseDir string, flattenedFileSummaries []*FileSummary) *DirSummary

NewDirSummary will create a new instance of DirSummary

type FileSummary

type FileSummary struct {
	RelativePath string
	ModTime      time.Time
	Checksum     *checksums.ChecksumResult
}

FileSummary holds the info for a single file

func NewFileSummary

func NewFileSummary(relativePath string, modTime time.Time, checksum *checksums.ChecksumResult) *FileSummary

NewFileSummary will create a new instance of FileSummary

func (*FileSummary) HaveSamePath

func (f *FileSummary) HaveSamePath(other *FileSummary) bool

HaveSamePath compares it to the path of another

type Service

type Service interface {
	GetFileSummary(dirPath, relPath string) (*FileSummary, error)
	GetDirSummary(dirPath string) (*DirSummary, error)
}

Service is the filepath summary service

func New

func New(checksumsSvc checksums.Service) Service

New creates a new service instance