Add docblocks to method description in interfaces. [ci skip]

This commit is contained in:
Andrey Smirnov
2014-02-19 13:44:14 +04:00
parent 2d589bd23d
commit 35c2178074
+16
View File
@@ -12,19 +12,29 @@ import (
// //
// PackagePool stores all the package files, deduplicating them. // PackagePool stores all the package files, deduplicating them.
type PackagePool interface { type PackagePool interface {
// Path returns full path to package file in pool given any name and hash of file contents
Path(filename string, hashMD5 string) (string, error) Path(filename string, hashMD5 string) (string, error)
// RelativePath returns path relative to pool's root for package files given MD5 and original filename
RelativePath(filename string, hashMD5 string) (string, error) RelativePath(filename string, hashMD5 string) (string, error)
// FilepathList returns file paths of all the files in the pool
FilepathList(progress Progress) ([]string, error) FilepathList(progress Progress) ([]string, error)
// Remove deletes file in package pool returns its size
Remove(path string) (size int64, err error) Remove(path string) (size int64, err error)
} }
// PublishedStorage is abstraction of filesystem storing all published repositories // PublishedStorage is abstraction of filesystem storing all published repositories
type PublishedStorage interface { type PublishedStorage interface {
// PublicPath returns root of public part
PublicPath() string PublicPath() string
// MkDir creates directory recursively under public path
MkDir(path string) error MkDir(path string) error
// CreateFile creates file for writing under public path
CreateFile(path string) (*os.File, error) CreateFile(path string) (*os.File, error)
// RemoveDirs removes directory structure under public path
RemoveDirs(path string) error RemoveDirs(path string) error
// LinkFromPool links package file from pool to dist's pool location
LinkFromPool(prefix string, component string, poolDirectory string, sourcePool PackagePool, sourcePath string) (string, error) LinkFromPool(prefix string, component string, poolDirectory string, sourcePool PackagePool, sourcePath string) (string, error)
// ChecksumsForFile proxies requests to utils.ChecksumsForFile, joining public path
ChecksumsForFile(path string) (utils.ChecksumInfo, error) ChecksumsForFile(path string) (utils.ChecksumInfo, error)
} }
@@ -48,9 +58,15 @@ type Progress interface {
// Downloader is parallel HTTP fetcher // Downloader is parallel HTTP fetcher
type Downloader interface { type Downloader interface {
// Download starts new download task
Download(url string, destination string, result chan<- error) Download(url string, destination string, result chan<- error)
// DownloadWithChecksum starts new download task with checksum verification
DownloadWithChecksum(url string, destination string, result chan<- error, expected utils.ChecksumInfo, ignoreMismatch bool) DownloadWithChecksum(url string, destination string, result chan<- error, expected utils.ChecksumInfo, ignoreMismatch bool)
// Pause pauses task processing
Pause() Pause()
// Resume resumes task processing
Resume() Resume()
// Shutdown stops downloader after current tasks are finished,
// but doesn't process rest of queue
Shutdown() Shutdown()
} }