sync

Documentation

Index

• func GetEncryptionKey() ([]byte, error)
• type GlobalConfig
• type HandleFileOutcome
• type LocalConfig
• type LocalFileStateData
• type LocalStateData
• type RemoteFileStateData
• type RemoteStateData
• type SyncedFile
• type Syncer
  • func (s *Syncer) PerformSync() error

Functions

func GetEncryptionKey

func GetEncryptionKey() ([]byte, error)

Types

type GlobalConfig

type GlobalConfig struct {
	// Specifies which files should be synced for machines associated with each tag. The key in this map is the tag
	// name. The value is the list of files/directories that should be synced for that tag.
	TagPaths map[string][]string `yaml:"paths"`
}

type HandleFileOutcome

type HandleFileOutcome int

const (
	DownloadedFile HandleFileOutcome = iota
	UploadedFile
	MarkedDeleted
	NoChange
)

type LocalConfig

type LocalConfig struct {
	// Specifies with tags this machine should be associated with.
	Tags []string `yaml:"tags"`
}

type LocalFileStateData

type LocalFileStateData struct {
	// The last time this file has been uploaded/downloaded from the cloud.
	LastCloudUpdate time.Time
	// Whether this file has been deleted locally.
	DeletedLocal bool
}

type LocalStateData

type LocalStateData struct {
	// Key is file path. Value is the state data associated with that file.
	FileStateData map[string]*LocalFileStateData
}

type RemoteFileStateData

type RemoteFileStateData struct {
	// The datetime this file was marked as deleted.
	MarkDeleted time.Time
}

type RemoteStateData

type RemoteStateData struct {
	// Key is file path. Value is the state data associated with that file.
	FileStateData map[string]*RemoteFileStateData
}

type SyncedFile

type SyncedFile struct {
	FriendlyPath string
	RealPath     string
	IsRemoteDir  bool
}

type Syncer

type Syncer struct {
	RemoteFileStore filestore.FileStore
	LocalFileStore  filestore.FileStore
	Logger          utils.Logger
	// Used to encrypt files stored in the remote file store.
	Encryptor utils.ReaderEncryptor
	// ForceDownload will download a file even if the local modified time is after the remote modified time.
	ForceDownload bool
	// contains filtered or unexported fields
}

func (*Syncer) PerformSync

func (s *Syncer) PerformSync() error

PerformSync does the entire sync from end to end.