Package accounting providers an accounting and limiting reader.

Package asyncreader provides an asynchronous reader which reads independently of write.

Package cache implements the Fs cache.

Package chunkedreader provides functionality for reading in chunks.

Package chunksize calculates a suitable chunk size for large uploads.

Package config reads, writes and edits the config file and deals with command line flags.

Package dirtree contains the DirTree type which is used for building filesystem hierarchies in memory.

Package driveletter returns whether a name is a valid drive letter.

Package filter controls the filtering of files.

Package fserrors provides errors and error handling.

Package fshttp contains the common http parts of the config, Transport and Client.

Package fspath contains routines for fspath manipulation.

Package hash provides hash utilities for Fs.

Package list contains list functions.

Package log provides logging for rclone.

Package march traverses two directories in lock step.

Package object defines some useful Objects.

Package operations does generic operations on filesystems and objects.

Package rc implements a remote control server and registry for rclone To register your internal calls, call rc.Add(path, function).

Package sync is the implementation of sync/copy/move.

Package walk walks directories.

AddConfig returns a mutable config structure based on a shallow copy of that found in ctx and returns a new context with that added to it.

BackendConfig calls the config for the backend in ri It wraps any OAuth transactions as necessary so only straight forward config questions are emitted.

CheckClose is a utility function used to check the return from Close in a defer statement.

CompareDirEntries returns 1 if a > b, 0 if a == b and -1 if a < b If two dir entries have the same name, compare their types (directories are before objects).

ConfigChoose returns a ConfigOut structure which has a list of suggested items.

ConfigChooseExclusive returns a ConfigOut structure which has a list of items to choose from.

ConfigChooseExclusiveFixed returns a ConfigOut structure which has a list of items to choose from.

ConfigChooseFixed returns a ConfigOut structure which has a list of suggested items.

ConfigConfirm returns a ConfigOut structure which asks a Yes/No question state should be the next state required Default should be the default state name is the config name for this item help should be the help shown to the user.

ConfigError shows the error to the user and goes to the state passed in state should be the next state required Error should be the error shown to the user.

ConfigFs makes the config for calling NewFs with.

ConfigGoto goes to the next state with empty Result state should be the next state required.

ConfigInput asks the user for a non-empty string state should be the next state required name is the config name for this item help should be the help shown to the user.

ConfigInputOptional asks the user for a string which may be empty state should be the next state required name is the config name for this item help should be the help shown to the user.

ConfigMap creates a configmap.Map from the *RegInfo and the configName passed in.

ConfigOAuthOnly marks the ctx so that the Config will stop after finding an OAuth.

ConfigPassword asks the user for a password state should be the next state required name is the config name for this item help should be the help shown to the user.

ConfigResult goes to the next state with result given state should be the next state required result should be the result for the next state.

ConfigString returns a canonical version of the config string used to configure the Fs as passed to fs.NewFs.

ConfigStringFull returns a canonical version of the config string used to configure the Fs as passed to fs.NewFs.

ConfigToEnv converts a config section and name, e.g.

CopyConfig copies the global config (if any) from srcCtx into dstCtx returning the new context.

Debugf writes debugging output for this Object or Fs.

DirEntryType returns a string description of the DirEntry, either "object", "directory" or "unknown type XXX".

Errorf writes error log output for this Object or Fs.

FileExists returns true if a file remote exists.

Find looks for a RegInfo object for the name passed in.

FindFromFs finds the *RegInfo used to create this Fs, provided it was created by fs.NewFs or cache.Get It returns nil if not found.

Fingerprint produces a unique-ish string for an object.

FixRangeOption looks through the slice of options and adjusts any RangeOption~s found that request a fetch from the end into an absolute fetch using the size passed in and makes sure the range does not exceed filesize.

GetConfig returns the global or context sensitive context.

GetMetadata from an ObjectInfo If the object has no metadata then metadata will be nil.

GetMetadataOptions from an ObjectInfo and merge it with any in options If --metadata isn't in use it will return nil If the object has no metadata then metadata will be nil.

GetModifyWindow calculates the maximum modify window between the given Fses and the Config.ModifyWindow parameter.

Infof writes info on transfers for this Object or Fs.

IsDaemon returns true if this process runs in background.

IsMountHelper returns true if rclone was invoked as mount helper: as /sbin/mount.rlone (by /bin/mount) or /usr/bin/rclonefs (by fusermount or directly).

LogDirName returns an object for the logger, logging a root directory which would normally be "" as the Fs.

Logf writes log output for this Object or Fs.

LogLevelPrintf writes logs at the given level.

LogPrintf produces a log string from the arguments passed in.

LogValue should be used as an argument to any logging calls to augment the JSON output with more structured information.

LogValueHide should be used as an argument to any logging calls to augment the JSON output with more structured information.

MatchProvider returns true if provider matches the providerConfig string.

MimeType returns the MimeType from the object, either by calling the MimeTyper interface or using MimeTypeFromName.

MimeTypeDirEntry returns the MimeType of a DirEntry It returns "inode/directory" for directories, or uses MimeType(Object).

MimeTypeFromName returns a guess at the mime type from the name.

MustFind looks for an Info object for the type name passed in Services are looked up in the config file.

NewConfig creates a new config with everything set to the default value.

NewDir creates an unspecialized Directory object If the modTime is unknown pass in time.Time{}.

NewDirCopy creates an unspecialized copy of the Directory object passed in.

NewFs makes a new Fs object from the path The path is of the form remote:path Remotes are looked up in the config file.

NewOverrideDirectory returns an OverrideDirectoryObject which will return the remote specified.

NewOverrideRemote returns an OverrideRemoteObject which will return the remote specified.

NewPacer creates a Pacer for the given Fs and Calculator.

NewUsageValue makes a valid value.

ObjectOptionalInterfaces returns the names of supported and unsupported optional interfaces for an Object.

OpenOptionAddHeaders adds each header found in options to the headers map provided the key was non empty.

OpenOptionAddHTTPHeaders Sets each header found in options to the http.Header map provided the key was non empty.

OpenOptionHeaders adds each header found in options to the headers map provided the key was non empty.

OptionToEnv converts an option name, e.g.

ParseDuration parses a duration string.

ParseRangeOption parses a RangeOption from a Range: header.

ParseRemote deconstructs a path into configName, fsPath, looking up the fsName in the config file (returning NotFoundInConfigFile if not found).

ParseTime parses a time or duration string as a Time.

Register a filesystem Fs modules should use this in an init() function.

StatePop pops a state from the front of the config string It returns the new state and the value popped.

StatePush pushes a new values onto the front of the config string.

TemporaryLocalFs creates a local FS in the OS's temporary directory.

Type returns a textual string to identify the type of the remote.

UnmarshalJSONFlag unmarshals a JSON input for a flag.

UnWrapFs unwraps f as much as possible and returns the base Fs.

UnWrapObject unwraps o as much as possible and returns the base object.

UnWrapObjectInfo returns the underlying Object unwrapped as much as possible or nil.

ConfigAll should be passed in as the initial state to run the entire config.

ConfigKeyEphemeralPrefix marks config keys which shouldn't be stored in the config file.

ConfigToken is the key used to store the token under.

Common multipliers for SizeSuffix.

CountSuffixMax is the largest CountSuffix multiplier.

CountSuffixMaxValue is the largest value that can be used to create CountSuffix.

CountSuffixMinValue is the smallest value that can be used to create CountSuffix.

MaxTransferMode constants.

MaxTransferMode constants.

MaxTransferMode constants.

MaxTransferMode constants.

We use a special environment variable to let the child process know its role.

We use a special environment variable to let the child process know its role.

DeleteMode constants.

DeleteMode constants.

DeleteMode constants.

DeleteMode constants.

DeleteMode constants.

DeleteMode constants.

DumpFlags definitions.

DumpFlags definitions.

DumpFlags definitions.

DumpFlags definitions.

DumpFlags definitions.

DumpFlags definitions.

DumpFlags definitions.

DumpFlags definitions.

DurationOff is the default value for flags which can be turned off.

0.

1.

Common multipliers for SizeSuffix.

Common multipliers for SizeSuffix.

Common multipliers for SizeSuffix.

Common multipliers for SizeSuffix.

Common multipliers for SizeSuffix.

Common multipliers for SizeSuffix.

Log levels.

Log levels.

Debug level, needs -vv.

Log levels.

Error - can't be suppressed.

Transfers, needs -v.

Normal logging, -q suppresses.

Log levels.

MaxLevel is a sentinel representing an infinite depth for listings.

Common multipliers for SizeSuffix.

Common multipliers for SizeSuffix.

ModTimeNotSupported is a very large precision value to show mod time isn't supported on this Fs.

Constants Option.Hide.

Constants Option.Hide.

Constants Option.Hide.

Common multipliers for SizeSuffix.

Common multipliers for SizeSuffix.

Common multipliers for SizeSuffix.

SizeSuffixMax is the largest SizeSuffix multiplier.

SizeSuffixMaxValue is the largest value that can be used to create SizeSuffix.

SizeSuffixMinValue is the smallest value that can be used to create SizeSuffix.

Common multipliers for SizeSuffix.

Common multipliers for SizeSuffix.

TerminalColorMode constants.

TerminalColorMode constants.

TerminalColorMode constants.

ConfigEdit is the config key used to show we wish to edit existing entries.

Read a value from the config file This is a function pointer to decouple the config implementation from the fs.

Check if the config file has the named section This is a function pointer to decouple the config implementation from the fs.

Set a value into the config file and persist it This is a function pointer to decouple the config implementation from the fs.

ConfigOAuth should be called to do the OAuth set in lib/oauthutil to avoid a circular import.

ConfigProvider is the config key used for provider options.

CountError counts an error.

DumpFlagsList is a list of dump flags used in the help.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

Globals.

ErrorNotFoundInConfigFile is returned by NewFs if not found in config file.

Globals.

Globals.

Globals.

Globals.

LogPrint sends the text to the logger of level.

LogPrintPid enables process pid in log.

PassDaemonArgsAsEnviron tells how CLI arguments are passed to the daemon When false, arguments are passed as is, visible in the `ps` output.

Registry of filesystems.

Version of rclone containing the complete version string.

VersionSuffix of rclone containing the pre-release label if any.

VersionTag of rclone.

BwPair represents an upload and a download bandwidth.

BwTimeSlot represents a bandwidth configuration at a point in time.

CommandHelp describes a single backend Command These are automatically inserted in the docs.

ConfigIn is passed to the Config function for an Fs The interactive config system for backends is state based.

ConfigInfo is filesystem config options.

ConfigOut is returned from Config function for an Fs State is the state for the next call to Config OAuth is a special value set by oauthutil.ConfigOAuth Error is displayed to the user before asking a question Result is passed to the next call to Config if Option/OAuth isn't set.

Dir describes an unspecialized directory for directory/container/bucket lists.

Features describe the optional features of the Fs.

HashesOption defines an option used to tell the local fs to limit the number of hashes it calculates.

HTTPOption defines a general purpose HTTP option.

LogValueItem describes keyed item for a JSON log entry.

MetadataHelp represents help for a bit of system metadata.

MetadataInfo is help for the whole metadata for this backend.

NullOption defines an Option which does nothing.

ObjectPair is a pair of Objects used to describe a potential copy operation.

Option is describes an option for the config wizard This also describes command line options and environment variables.

OptionExample describes an example for an Option.

OverrideDirectory is a wrapper to override the Remote for an Directory.

OverrideRemote is a wrapper to override the Remote for an ObjectInfo.

Pacer is a simple wrapper around a pacer.Pacer with logging.

RangeOption defines an HTTP Range option with start and end.

RegInfo provides information about a filesystem.

SeekOption defines an HTTP Range option with start only.

Tristate is a boolean that can has the states, true, false and unset/invalid/nil.

Usage is returned by the About call If a value is nil then it isn't supported by that backend.

Abouter is an optional interface for Fs.

ChangeNotifier is an optional interface for Fs.

CleanUpper is an optional interfaces for Fs.

Commander is an interface to wrap the Command function.

Copier is an optional interface for Fs.

DirCacheFlusher is an optional interface for Fs.

Directory is a filesystem like directory provided by an Fs.

DirEntry provides read only information about the common subset of a Dir or Object.

DirMover is an optional interface for Fs.

Disconnecter is an optional interface for Fs.

Fs is the interface a cloud storage system must provide.

FullObject contains all the optional interfaces for Object Use for checking making wrapping Objects implement everything.

FullObjectInfo contains all the read-only optional interfaces Use for checking making wrapping ObjectInfos implement everything.

GetTierer is an optional interface for Object.

IDer is an optional interface for Object.

Info provides a read only interface to information about a filesystem.

ListRer is an optional interfaces for Fs.

MergeDirser is an option interface for Fs.

Metadataer is an optional interface for Object.

MimeTyper is an optional interface for Object.

Mover is an optional interface for Fs.

Object is a filesystem like object provided by an Fs.

ObjectInfo provides read only information about an object.

ObjectUnWrapper is an optional interface for Object.

OpenOption is an interface describing options for Open.

OpenWriterAter is an optional interface for Fs.

ParentIDer is an optional interface for Object.

PublicLinker is an optional interface for Fs.

Purger is an optional interfaces for Fs.

PutStreamer is an optional interface for Fs.

PutUncheckeder is an optional interface for Fs.

RangeSeeker is the interface that wraps the RangeSeek method.

SetTierer is an optional interface for Object.

Shutdowner is an interface to wrap the Shutdown function.

UnWrapper is an optional interfaces for Fs.

UserInfoer is an optional interface for Fs.

Wrapper is an optional interfaces for Fs.

WriterAtCloser wraps io.WriterAt and io.Closer.

BaseOption is an alias for Option used internally.

BwTimetable contains all configured time slots.

CommaSepList is a comma separated config value It uses the encoding/csv rules for quoting and escaping.

CountSuffix is an int64 with a friendly way of printing setting.

CountSuffixList is a slice CountSuffix values.

CutoffMode describes the possible delete modes in the config.

DeleteMode describes the possible delete modes in the config.

DirEntries is a slice of Object or *Dir.

DumpFlags describes the Dump options in force.

Duration is a time.Duration with some more parsing options.

EntryType can be associated with remote paths to identify their type.

ListRCallback defines a callback function for ListR to use It is called for each tranche of entries read from the listing and if it returns an error, the listing stops.

ListRFn is defines the call used to recursively list a directory.

LogLevel describes rclone's logs.

Metadata represents Object metadata in a standardised form See docs/content/metadata.md for the interpretation of the keys.

MetadataOption defines an Option which does nothing.

Objects is a slice of Object~s.

OptionExamples is a slice of examples.

Options is a slice of configuration Option for a backend.

OptionVisibility controls whether the options are visible in the configurator or the command line.

SizeSuffix is an int64 with a friendly way of printing setting.

SizeSuffixList is a slice SizeSuffix values.

SpaceSepList is a space separated config value It uses the encoding/csv rules for quoting and escaping.

TerminalColorMode describes how ANSI codes should be handled.

Time is a time.Time with some more parsing options.