Documentation
¶
Index ¶
- Variables
- func CalculateModifyWindow(fs ...Fs)
- func Check(fdst, fsrc Fs) error
- func CheckMd5sums(src, dst Object) (bool, error)
- func Choose(what string, defaults, help []string, newOk bool) string
- func ChooseOption(o *Option) string
- func ChooseRemote() string
- func Command(commands []string) byte
- func Confirm() bool
- func Copier(in ObjectPairChan, fdst Fs, wg *sync.WaitGroup)
- func Copy(f Fs, dst, src Object)
- func Debug(o interface{}, text string, args ...interface{})
- func DeleteFiles(to_be_deleted ObjectsChan)
- func DeleteRemote(name string)
- func EditConfig()
- func EditRemote(name string)
- func Equal(src, dst Object) bool
- func List(f Fs) error
- func ListDir(f Fs) error
- func LoadConfig()
- func Log(o interface{}, text string, args ...interface{})
- func Mkdir(f Fs) error
- func NewRemote(name string)
- func OkRemote(name string) bool
- func OutputLog(o interface{}, text string, args ...interface{})
- func PairChecker(in ObjectPairChan, out ObjectPairChan, wg *sync.WaitGroup)
- func Purge(f Fs) error
- func ReadLine() string
- func Register(info *FsInfo)
- func RemoteConfig(name string)
- func Rmdir(f Fs) error
- func SaveConfig()
- func ShowRemote(name string)
- func ShowRemotes()
- func Sync(fdst, fsrc Fs, Delete bool) error
- type Account
- type ConfigInfo
- type Dir
- type DirChan
- type Fs
- type FsInfo
- type Limited
- func (f *Limited) List() ObjectsChan
- func (f *Limited) ListDir() DirChan
- func (f *Limited) Mkdir() error
- func (f *Limited) NewFsObject(remote string) Object
- func (f *Limited) Precision() time.Duration
- func (f *Limited) Put(in io.Reader, remote string, modTime time.Time, size int64) (Object, error)
- func (f *Limited) Rmdir() error
- func (f *Limited) String() string
- type Object
- type ObjectPair
- type ObjectPairChan
- type Objects
- type ObjectsChan
- type Option
- type OptionExample
- type Purger
- type StatsInfo
- func (s *StatsInfo) Bytes(bytes int64)
- func (s *StatsInfo) Checking(o Object)
- func (s *StatsInfo) DoneChecking(o Object)
- func (s *StatsInfo) DoneTransferring(o Object)
- func (s *StatsInfo) Error()
- func (s *StatsInfo) Errored() bool
- func (s *StatsInfo) Errors(errors int64)
- func (s *StatsInfo) GetErrors() int64
- func (s *StatsInfo) Log()
- func (s *StatsInfo) String() string
- func (s *StatsInfo) Transferring(o Object)
- type StringSet
Constants ¶
This section is empty.
Variables ¶
var ( // Config file ConfigFile *goconfig.ConfigFile // Home directory HomeDir = configHome() // Config file path ConfigPath = path.Join(HomeDir, configFileName) // Global config Config = &ConfigInfo{} )
Global
var (
Stats = NewStats()
)
Globals
Functions ¶
func CalculateModifyWindow ¶
func CalculateModifyWindow(fs ...Fs)
Work out modify window for fses passed in - sets Config.ModifyWindow
This is the largest modify window of all the fses in use, and the user configured value
func CheckMd5sums ¶
Check the two files to see if the MD5sums are the same
May return an error which will already have been logged ¶
If an error is returned it will return false
func Copier ¶
func Copier(in ObjectPairChan, fdst Fs, wg *sync.WaitGroup)
Read FsObjects on in and copy them
func Copy ¶
Copy src object to dst or f if nil
If dst is nil then the object must not exist already. If you do call Copy() with dst nil on a pre-existing file then some filing systems (eg Drive) may duplicate the file.
func Debug ¶
func Debug(o interface{}, text string, args ...interface{})
Write debuging output for this Object or Fs
func DeleteFiles ¶
func DeleteFiles(to_be_deleted ObjectsChan)
Delete all the files passed in the channel
func Equal ¶
Checks to see if the src and dst objects are equal by looking at size, mtime and MD5SUM
If the src and dst size are different then it is considered to be not equal.
If the size is the same and the mtime is the same then it is considered to be equal. This is the heuristic rsync uses when not using --checksum.
If the size is the same and and mtime is different or unreadable and the MD5SUM is the same then the file is considered to be equal. In this case the mtime on the dst is updated.
Otherwise the file is considered to be not equal including if there were errors reading info.
func Log ¶
func Log(o interface{}, text string, args ...interface{})
Write log output for this Object or Fs
func OutputLog ¶
func OutputLog(o interface{}, text string, args ...interface{})
Outputs log for object
func PairChecker ¶
func PairChecker(in ObjectPairChan, out ObjectPairChan, wg *sync.WaitGroup)
Read FsObjects~s on in send to out if they need uploading
FIXME potentially doing lots of MD5SUMS at once
Types ¶
type Account ¶
type Account struct {
// contains filtered or unexported fields
}
Account limits and accounts for one transfer
type ConfigInfo ¶
type ConfigInfo struct {
Verbose bool
Quiet bool
DryRun bool
ModifyWindow time.Duration
Checkers int
Transfers int
}
Filesystem config options
type Dir ¶
type Dir struct {
Name string // name of the directory
When time.Time // modification or creation time - IsZero for unknown
Bytes int64 // size of directory and contents -1 for unknown
Count int64 // number of objects -1 for unknown
}
A structure of directory/container/bucket lists
type Fs ¶
type Fs interface {
// String returns a description of the FS
String() string
// List the Fs into a channel
List() ObjectsChan
// List the Fs directories/buckets/containers into a channel
ListDir() DirChan
// Find the Object at remote. Returns nil if can't be found
NewFsObject(remote string) Object
// Put in to the remote path with the modTime given of the given size
//
// May create the object even if it returns an error - if so
// will return the object and the error, otherwise will return
// nil and the error
Put(in io.Reader, remote string, modTime time.Time, size int64) (Object, error)
// Make the directory (container, bucket)
Mkdir() error
// Remove the directory (container, bucket) if empty
Rmdir() error
// Precision of the ModTimes in this Fs
Precision() time.Duration
}
A Filesystem, describes the local filesystem and the remote object store
func NewFs ¶
NewFs makes a new Fs object from the path
The path is of the form service://path
Services are looked up in the config file
func NewLimited ¶
NewLimited maks a limited Fs limited to the objects passed in
type FsInfo ¶
type FsInfo struct {
// Name of this fs
Name string
// Create a new file system. If root refers to an existing
// object, then it should return a Fs which only returns that
// object.
NewFs func(name string, root string) (Fs, error)
// Function to call to help with config
Config func(string)
// Options for the Fs configuration
Options []Option
}
Filesystem info
type Limited ¶
type Limited struct {
// contains filtered or unexported fields
}
This defines a Limited Fs which can only return the Objects passed in from the Fs passed in
func (*Limited) NewFsObject ¶
Find the Object at remote. Returns nil if can't be found
func (*Limited) Put ¶
Put in to the remote path with the modTime given of the given size
May create the object even if it returns an error - if so will return the object and the error, otherwise will return nil and the error
type Object ¶
type Object interface {
// String returns a description of the Object
String() string
// Fs returns the Fs that this object is part of
Fs() Fs
// Remote returns the remote path
Remote() string
// Md5sum returns the md5 checksum of the file
Md5sum() (string, error)
// ModTime returns the modification date of the file
ModTime() time.Time
// SetModTime sets the metadata on the object to set the modification date
SetModTime(time.Time)
// Size returns the size of the file
Size() int64
// Open opens the file for read. Call Close() on the returned io.ReadCloser
Open() (io.ReadCloser, error)
// Update in to the object with the modTime given of the given size
Update(in io.Reader, modTime time.Time, size int64) error
// Storable says whether this object can be stored
Storable() bool
// Removes this object
Remove() error
}
A filesystem like object which can either be a remote object or a local file/directory
type ObjectPair ¶
type ObjectPair struct {
// contains filtered or unexported fields
}
A pair of Objects
type Option ¶
type Option struct {
Name string
Help string
Optional bool
Examples []OptionExample
}
An options for a Fs
type OptionExample ¶
An example for an option
type Purger ¶
type Purger interface {
// Purge all files in the root and the root directory
//
// Implement this if you have a way of deleting all the files
// quicker than just running Remove() on the result of List()
Purge() error
}
Optional interfaces
type StatsInfo ¶
type StatsInfo struct {
// contains filtered or unexported fields
}
Stats limits and accounts all transfers
func (*StatsInfo) DoneChecking ¶
DoneChecking removes a check from the stats
func (*StatsInfo) DoneTransferring ¶
DoneTransferring removes a transfer from the stats
func (*StatsInfo) Transferring ¶
Transferring adds a transfer into the stats