src

type Client struct {
	// Specific s3 client for this remote
	Client *s3.S3
	// Set of options for this remote
	RemoteOptions Remote
}

type Clients struct {
	// Array of remotes.
	Remotes []Client
}

type LocalFileSummary struct {
	// Name of object
	Name string
	// Pointer to some file object that is either an s3 object version or an os.File
	File *os.File
	// Error if there was any with finding the operation.
	Error error
}

type OptionMeta struct {
	// The exact file descriptor of the options file.
	File *os.File
	// Raw file data of the options file
	FileData []byte
	// Absolute path to options file
	FilePath string
	// Unmarshalled options information
	Options *Options

	// List of s3 clients for each of the remotes that are defined in
	// the options file. Depending on mode there could be only 1 client in the object.
	Clients []Client
	// Earlier parts of the program find the default remote, and this will be the
	// index value for downstream operation to reference the slice instance without having to do all sorts
	// of stuff with finding the default value again.
	DefaultRemoteIndex int
	// This is the default client referenced by the "default" synching routine.
	DefClient *Client
}

type Options struct {
	// Specifies the supposed name of the databse that you want to sync
	// with this binary. Should be a name
	DatabaseName string `json:"db_name" yaml:"DatabaseName"`
	// Use this regex to match files in the specified directory and just choose
	// the newest file that is matched by tyhe regex.
	DatabaseRegex string `json:"db_regex" yaml:"DatabaseRegex"`
	// Array of remotes that can be uploaded to/downloaded form.
	Remotes []Remote `json:"remotes" yaml:"Remotes"`
}

type Remote struct {
	// Name of the remote endpoint.
	Name string `json:"name" yaml:"Name"`
	// Actual URI of the endpoint.
	Endpoint string `json:"endpoint" yaml:"Endpoint"`
	// Specify the region of the endpoint to pass in to the sdk.
	Region string `json:"region" yaml:"Region"`
	// Specify the bucket name to sync with
	Bucket string `json:"bucket" yaml:"Bucket"`
	// API key id of the remote.
	Id string `json:"api_id" yaml:"ApiId"`
	// API key of the remote.
	Key string `json:"api_key" yaml:"ApiKey"`
	// Only one of these remotes can be specified as default, but if this
	// bool is set to true, the binary will default to try and sync with
	// this remote as the first attempt. Only one remote in each file can be set
	// to default, otherwise the "default" remote will be inconsistently chosen.
	IsDefault bool `json:"isdefault" yaml:"IsDefault"`
}

type RemoteFileSumary struct {
	// Name of object
	Name string
	// Pointer to some file object that is either an s3 object version or an os.File
	File *s3.ObjectVersion
	// Error if there was any with finding the operation.
	Error error
	// Return client that should be used for future operations.
	Client *Client
}