package
1.64.0-Personal
Repository: https://github.com/dceldran/rclone.git
Documentation: pkg.go.dev

# Functions

BackupDir returns the correctly configured --backup-dir.
CanServerSideMove returns true if fdst support server-side moves or server-side copies Some remotes simulate rename by server-side copy and delete, so include remotes that implements either Mover or Copier.
Cat any files to the io.Writer if offset == 0 it will be ignored if offset > 0 then the file will be seeked to that offset if offset < 0 then the file will be seeked that far from the end if count < 0 then it will be ignored if count >= 0 then only that many characters will be output.
Check the files in fsrc and fdst according to Size and hash.
CheckDownload checks the files in fsrc and fdst according to Size and the actual contents of the files.
CheckEqualReaders checks to see if in1 and in2 have the same content when read.
CheckFn checks the files in fsrc and fdst according to Size and hash using checkFunction on each file to check the hashes.
CheckHashes checks the two files to see if they have common known hash types and compares them Returns.
CheckIdenticalDownload checks to see if dst and src are identical by reading all their bytes if necessary.
CheckSum checks filesystem hashes against a SUM file.
CleanUp removes the trash for the Fs.
CommonHash returns a single hash.Type and a HashOption with that type which is in common between the two fs.Fs.
CompareOrCopyDest checks --compare-dest and --copy-dest to see if src does not need to be copied Returns True if src does not need to be copied.
ConfigMaxDepth returns the depth to use for a recursive or non recursive listing.
Copy src object to dst or f if nil.
CopyFile moves a single file possibly to a new name.
CopyURL copies the data from the url to (fdst, dstFileName).
CopyURLToWriter copies the data from the url to the io.Writer supplied.
Count counts the objects and their sizes in the Fs Obeys includes and excludes.
CountString make string representation of count for output Optional human-readable format including a decimal suffix.
CountStringField make string representation of count for output in fixed width field Similar to SizeStringField, but human readable with decimal prefix and field width 8 since there is no 'i' in the decimal prefix symbols (e.g.
Deduplicate interactively finds duplicate files and offers to delete all but one or rename them to be different.
Delete removes all the contents of a container.
DeleteFile deletes a single file respecting --dry-run and accumulating stats and errors.
DeleteFiles removes all the files passed in the channel.
DeleteFilesWithBackupDir removes all the files passed in the channel If backupDir is set the files will be placed into that directory instead of being deleted.
DeleteFileWithBackupDir deletes a single file respecting --dry-run and accumulating stats and errors.
DirMove renames srcRemote to dstRemote It does this by loading the directory tree into memory (using ListR if available) and doing renames in parallel.
Equal checks to see if the src and dst objects are equal by looking at size, mtime and hash If the src and dst size are different then it is considered to be not equal.
GetCompareDest sets up --compare-dest.
GetCopyDest sets up --copy-dest.
GetFsInfo gets the information (FsInfo) about a given Fs.
HashLister does an md5sum equivalent for the hash type passed in Updated to handle both standard hex encoding and base64 Updated to perform multiple hashes concurrently.
HashSumStream outputs a line compatible with md5sum to w based on the input stream in and the hash type ht passed in.
List the Fs to the supplied writer Shows size and path - obeys includes and excludes.
ListDir lists the directories/buckets/containers in the Fs to the supplied writer.
ListFn lists the Fs to the supplied function Lists in parallel which may get them out of order.
ListJSON lists fsrc using the options in opt calling callback for each item.
ListLong lists the Fs to the supplied writer Shows size, mod time and path - obeys includes and excludes.
Mkdir makes a destination directory or container.
Move src object to dst or fdst if nil.
MoveBackupDir moves a file to the backup dir.
MoveFile moves a single file possibly to a new name.
NeedTransfer checks to see if src needs to be copied to dst using the current config.
NewReOpen makes a handle which will reopen itself and seek to where it was on errors up to maxTries times.
Open makes a handle which will reopen itself and seek to where it was on errors.
OverlappingFilterCheck returns true if fdst and fsrc point to the same underlying Fs and they overlap without fdst being excluded by any filter rule.
ParseSumFile parses a hash SUM file and returns hashes as a map.
PublicLink adds a "readable by anyone with link" permission on the given file or folder.
Purge removes a directory and all of its contents.
Rcat reads data from the Reader until EOF and uploads it to a file on remote.
RcatSize reads data from the Reader until EOF and uploads it to a file on remote.
Retry runs fn up to maxTries times if it returns a retriable error.
Rmdir removes a container but not if not empty.
Rmdirs removes any empty directories (or directories only containing empty directories) under f, including f.
Same returns true if fdst and fsrc point to the same underlying Fs.
SameConfig returns true if fdst and fsrc are using the same config file entry.
SameConfigArr returns true if any of []fsrcs has same config file entry with fdst.
SameDir returns true if fdst and fsrc point to the same underlying Fs and they are the same directory.
SameObject returns true if src and dst could be pointing to the same object.
SameRemoteType returns true if fdst and fsrc are the same type.
SetTier changes tier of object in remote.
SizeString make string representation of size for output Optional human-readable format including a binary suffix.
SizeStringField make string representation of size for output in fixed width field Optional human-readable format including a binary suffix Argument rawWidth is used to format field with of raw value.
SkipDestructive should be called whenever rclone is about to do an destructive operation.
StatJSON returns a single JSON stat entry for the fsrc, remote path The item returned may be nil if it is not found or excluded with DirsOnly/FilesOnly.
SuffixName adds the current --suffix to the remote, obeying --suffix-keep-extension if set.
TouchDir touches every file in directory with time t.
TryRmdir removes a container but not if not empty.

# Constants

choose the first object.
interactively ask the user.
choose the largest object.
list duplicates only.
choose the newest object.
choose the oldest object.
rename the objects.
skip all conflicts.
choose the smallest object.

# Variables

StdoutMutex mutex for synchronized output on stdout.
SyncPrintf is a global var holding the Printf function so that it can be overridden.

# Structs

CheckOpt contains options for the Check functions.
FsInfo provides information about a remote.
ListFormat defines files information print format.
ListJSONItem in the struct which gets marshalled for each line.
ListJSONOpt describes the options for ListJSON.
ReOpen is a wrapper for an object reader which reopens the stream on error.
Timestamp a time in the provided format.

# Type aliases

DeduplicateMode is how the dedupe command chooses what to do.
HashSums represents a parsed SUM file.