rclone

README

Rclone Integrations

Rclone can be used as a subcommand with: $ suitcasectl rclone src dest.

The destination must be a valid rclone endpoint, usually configured in ~/.config/rclone/rclone.conf, however the rclone binary itself is not needed.

Pretty decent API doc here

Documentation

Overview

Package rclone contains all the rclone operations

Index

• func APIOneShot(command string, params rc.Params) error
• func Clone(source, destination string) error
• func Copy(source, destination string, c chan TransferStatus) error
• func Exists(d string) bool
• type TransferStatus

Functions

func APIOneShot

func APIOneShot(command string, params rc.Params) error

APIOneShot is a generic way to call the API. Good for single commands to send through that don't have to wait and such

func Clone

func Clone(source, destination string) error

Clone mimics rclonse 'clone' option, given a source and destination

func Copy

func Copy(source, destination string, c chan TransferStatus) error

Copy copies a single file to the destination

func Exists

func Exists(d string) bool

Exists checks to see if a destination exists. This is useful as a pre-flight check

Types

type TransferStatus

type TransferStatus struct {
	Name   string    `json:"name,omitempty"`
	Stats  jobStats  `json:"stats,omitempty"`
	Status jobStatus `json:"status,omitempty"`
}

TransferStatus is the status of a transfer, used for reporting back to our travel agent or such