rclone

Documentation

Overview

Package rclone implements blob storage provider proxied by rclone (http://rclone.org)

Index

• func New(ctx context.Context, opt *Options, isCreate bool) (blob.Storage, error)
• type Options

Functions

func New

func New(ctx context.Context, opt *Options, isCreate bool) (blob.Storage, error)

New creates new RClone storage with specified options. nolint:funlen

Types

type Options

type Options struct {
	RemotePath         string   `json:"remotePath"`                   // remote:path supported by RClone
	RCloneExe          string   `json:"rcloneExe,omitempty"`          // path to rclone executable
	RCloneArgs         []string `json:"rcloneArgs,omitempty"`         // additional rclone arguments
	RCloneEnv          []string `json:"rcloneEnv,omitempty"`          // additional rclone environment variables
	StartupTimeout     int      `json:"startupTimeout,omitempty"`     // time to wait for rclone to start
	Debug              bool     `json:"debug,omitempty"`              // log rclone output
	NoWaitForTransfers bool     `json:"noWaitForTransfers,omitempty"` // when set to true, don't wait for transfers to finish when closing
	EmbeddedConfig     string   `json:"embeddedConfig,omitempty"`
	AtomicWrites       bool     `json:"atomicWrites"`

	sharded.Options
	throttling.Limits
}

Options defines options for RClone storage.