Struct Client 

pub struct Client { /* private fields */ }

Client for Rclone RC API

Full OpenAPI specification for the Rclone RC API.

Version: 0.1.3

Implementations

impl Client

pub fn new(baseurl: &str) -> Self

Create a new client.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

pub fn new_with_client(baseurl: &str, client: Client) -> Self

Construct a new client with an existing reqwest::Client, allowing more control over its configuration.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

impl Client

pub async fn rc_noop<'a>( &'a self, async_: Option<bool>, params: Option<&'a Map<String, Value>>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Echo request parameters

Returns all supplied parameters unchanged so you can verify RC connectivity.

Sends a POST request to /rc/noop

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• params: Additional arbitrary parameters allowed.

pub async fn operations_cleanup<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Remove trashed files

Permanently removes trashed objects from the specified remote path.

Sends a POST request to /operations/cleanup

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path to clean up, for example drive:.

pub async fn operations_copyfile<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, dst_fs: &'a str, dst_remote: &'a str, src_fs: &'a str, src_remote: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Copy a single file

Copies one object from a source remote and path to a destination remote and path.

Sends a POST request to /operations/copyfile

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• dst_fs: Destination remote name or path, such as drive2: or / for local filesystem.
• dst_remote: Target path within dstFs where the file should be written.
• src_fs: Source remote name or path, such as drive: or / for the local filesystem.
• src_remote: Path to the source object within srcFs, for example dir/file.txt.

pub async fn operations_copyurl<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, auto_filename: Option<bool>, fs: &'a str, remote: &'a str, url: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Copy from URL

Downloads a public URL and stores it at the requested remote path.

Sends a POST request to /operations/copyurl

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• auto_filename: Set to true to derive the destination filename from the URL.
• fs: Remote name or path that will receive the downloaded file, e.g. drive:.
• remote: Destination path within fs where the fetched object will be stored.
• url: Source URL to fetch the object from.

pub async fn operations_delete<'a>( &'a self, async_: Option<bool>, config: Option<&'a str>, filter: Option<&'a str>, group: Option<&'a str>, fs: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Delete objects in path

Deletes matching files and directories for the provided remote, honouring filters and config overrides.

Sends a POST request to /operations/delete

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• config: JSON encoded config overrides applied for this call only.
• filter: JSON encoded filter overrides applied for this call only.
• group: Assign the request to a custom stats group.
• fs: Remote name or path whose contents should be removed.

pub async fn operations_deletefile<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, remote: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Delete single file

Removes a specific object from the remote.

Sends a POST request to /operations/deletefile

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path that contains the file to delete.
• remote: Exact path to the file within fs that should be deleted.

pub async fn operations_fsinfo<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, ) -> Result<ResponseValue<OperationsFsinfoResponse>, Error<RcError>>

Describe remote capabilities

Returns backend features, hash support, metadata descriptions, and other info for the remote.

Sends a POST request to /operations/fsinfo

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path to inspect, e.g. drive:.

pub async fn operations_hashsum<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, base64: Option<bool>, download: Option<bool>, fs: &'a str, hash_type: &'a str, ) -> Result<ResponseValue<OperationsHashsumResponse>, Error<RcError>>

Generate hash sums

Produces a hash sum listing for files under the given path using the requested hash algorithm.

Sends a POST request to /operations/hashsum

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• base64: Set to true to emit hash values in base64 rather than hexadecimal.
• download: Set to true to force reading the data instead of using remote checksums.
• fs: Remote name or path to hash, such as drive: or /.
• hash_type: Hash algorithm to use, e.g. md5, sha1, or another supported name.

pub async fn operations_movefile<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, dst_fs: &'a str, dst_remote: &'a str, src_fs: &'a str, src_remote: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Move a single file

Moves one object from a source remote and path to a destination remote and path.

Sends a POST request to /operations/movefile

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• dst_fs: Destination remote name or path where the file will be moved.
• dst_remote: Destination path within dstFs for the moved object.
• src_fs: Source remote name or path containing the file to move.
• src_remote: Path to the source object within srcFs.

pub async fn operations_publiclink<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, expire: Option<&'a str>, fs: &'a str, remote: &'a str, unlink: Option<bool>, ) -> Result<ResponseValue<OperationsPubliclinkResponse>, Error<RcError>>

Create or remove public link

Creates a share URL for an object or removes an existing link when unlink=true.

Sends a POST request to /operations/publiclink

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• expire: Optional expiration time for the public link, formatted as supported by the backend.
• fs: Remote name or path hosting the object for which to manage a public link.
• remote: Path within fs to the object for which to create or remove a public link.
• unlink: Set to true to remove an existing public link instead of creating one.

pub async fn operations_rmdirs<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, leave_root: Option<bool>, remote: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Remove empty directories

Deletes empty subdirectories beneath the specified path, optionally leaving the root.

Sends a POST request to /operations/rmdirs

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path to scan for empty directories.
• leave_root: Set to true to preserve the top-level directory even if empty.
• remote: Path within fs whose empty subdirectories should be removed.

pub async fn operations_settier<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Change storage tier

Updates the storage class or tier for every object in the specified remote path.

Sends a POST request to /operations/settier

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path whose storage class tier should be changed.

pub async fn operations_settierfile<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, remote: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Change file storage tier

Updates the storage class or tier for a single object.

Sends a POST request to /operations/settierfile

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path that contains the object whose tier should change.
• remote: Path within fs to the object whose storage class tier should be updated.

pub async fn operations_size<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, ) -> Result<ResponseValue<OperationsSizeResponse>, Error<RcError>>

Count remote size

Reports total size, file count, and number of objects without size metadata.

Sends a POST request to /operations/size

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path to measure aggregate size information for.

pub async fn core_bwlimit<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, rate: Option<&'a str>, ) -> Result<ResponseValue<CoreBwlimitResponse>, Error<RcError>>

Get or update bandwidth limits

Reads the current bandwidth limit or applies a new schedule string, just like rclone rc core/bwlimit.

Sends a POST request to /core/bwlimit

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• rate: Bandwidth limit to apply, for example off, 5M, or a schedule string.

pub async fn core_command<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, arg: Option<&'a Vec<String>>, command: &'a str, opt: Option<&'a str>, return_type: Option<&'a str>, ) -> Result<ResponseValue<CoreCommandResponse>, Error<RcError>>

Run an rclone command

Executes a standard rclone CLI command remotely and streams or returns its output.

Sends a POST request to /core/command

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• arg: Optional positional arguments for the command. Repeat to supply multiple values.
• command: Name of the rclone command to execute, for example ls or lsf.
• opt: Optional command options encoded as a JSON string.
• return_type: Controls how output is returned; accepts COMBINED_OUTPUT, STREAM, STREAM_ONLY_STDOUT, or STREAM_ONLY_STDERR.

pub async fn core_du<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, dir: Option<&'a str>, ) -> Result<ResponseValue<CoreDuResponse>, Error<RcError>>

Report disk usage

Returns disk usage statistics for the supplied local directory (defaults to the cache dir).

Sends a POST request to /core/du

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• dir: Local directory path to report disk usage for. Defaults to the rclone cache directory when omitted.

pub async fn core_gc<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Force garbage collection

Triggers Go’s garbage collector to release unused memory.

Sends a POST request to /core/gc

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn core_group_list<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<CoreGroupListResponse>, Error<RcError>>

List stats groups

Lists stats groups currently tracked by rclone.

Sends a POST request to /core/group-list

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn core_memstats<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<HashMap<String, f64>>, Error<RcError>>

Fetch runtime memory stats

Returns Go runtime memory statistics similar to runtime.ReadMemStats.

Sends a POST request to /core/memstats

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn core_obscure<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, clear: &'a str, ) -> Result<ResponseValue<CoreObscureResponse>, Error<RcError>>

Obscure a clear string

Obscures a plain-text secret for inclusion in rclone.conf.

Sends a POST request to /core/obscure

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• clear: Plain-text string to obscure for storage in the config file.

pub async fn core_pid<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<CorePidResponse>, Error<RcError>>

Return rclone PID

Returns the process ID of the running rclone instance.

Sends a POST request to /core/pid

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn core_quit<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, exit_code: Option<i64>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Terminate rclone

Stops the rclone process, optionally supplying an exit code.

Sends a POST request to /core/quit

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• exit_code: Optional exit code to use when terminating the rclone process.

pub async fn core_stats_delete<'a>( &'a self, async_: Option<bool>, _group: Option<&'a str>, group: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Delete stats group

Deletes the counters associated with a specific stats group.

Sends a POST request to /core/stats-delete

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• group: Stats group identifier to remove.

pub async fn core_stats_reset<'a>( &'a self, async_: Option<bool>, _group: Option<&'a str>, group: Option<&'a str>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Reset stats counters

Clears counters, errors, and finished transfers for the provided stats group or all groups.

Sends a POST request to /core/stats-reset

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• group: Stats group identifier whose counters should be reset. Leave unset to reset all groups.

pub async fn core_transferred<'a>( &'a self, async_: Option<bool>, _group: Option<&'a str>, group: Option<&'a str>, ) -> Result<ResponseValue<CoreTransferredResponse>, Error<RcError>>

List completed transfers

Returns up to 100 recently completed transfers for the requested stats group.

Sends a POST request to /core/transferred

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• group: Stats group identifier to filter the completed transfer list. Leave unset for all groups.

pub async fn debug_set_block_profile_rate<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, rate: i64, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Sends a POST request to /debug/set-block-profile-rate

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• rate: Sampling interval in nanoseconds for blocking profile collection; use 1 to capture all events.

pub async fn debug_set_gc_percent<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, gc_percent: i64, ) -> Result<ResponseValue<DebugSetGcPercentResponse>, Error<RcError>>

Sends a POST request to /debug/set-gc-percent

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• gc_percent: Target percentage of newly allocated data to trigger garbage collection.

pub async fn debug_set_mutex_profile_fraction<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, rate: i64, ) -> Result<ResponseValue<DebugSetMutexProfileFractionResponse>, Error<RcError>>

Sends a POST request to /debug/set-mutex-profile-fraction

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• rate: Sampling fraction for mutex contention profiling; set to 0 to disable.

pub async fn debug_set_soft_memory_limit<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, mem_limit: i64, ) -> Result<ResponseValue<DebugSetSoftMemoryLimitResponse>, Error<RcError>>

Sends a POST request to /debug/set-soft-memory-limit

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• mem_limit: Soft memory limit for the Go runtime in bytes.

pub async fn fscache_clear<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Sends a POST request to /fscache/clear

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn fscache_entries<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<FscacheEntriesResponse>, Error<RcError>>

Sends a POST request to /fscache/entries

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn mount_listmounts<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<MountListmountsResponse>, Error<RcError>>

Sends a POST request to /mount/listmounts

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn mount_mount<'a>( &'a self, async_: Option<bool>, config: Option<&'a str>, filter: Option<&'a str>, group: Option<&'a str>, fs: &'a str, mount_opt: Option<&'a str>, mount_point: &'a str, mount_type: Option<&'a str>, vfs_opt: Option<&'a str>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Sends a POST request to /mount/mount

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• config: JSON encoded config overrides applied for this call only.
• filter: JSON encoded filter overrides applied for this call only.
• group: Assign the request to a custom stats group.
• fs: Remote path to mount, such as drive: or remote:subdir.
• mount_opt: Mount options encoded as JSON, matching flags accepted by rclone mount.
• mount_point: Absolute local path where the remote should be mounted.
• mount_type: Optional mount implementation to use (mount, cmount, or mount2).
• vfs_opt: VFS options encoded as JSON, matching flags accepted by rclone mount.

pub async fn mount_types<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<MountTypesResponse>, Error<RcError>>

Sends a POST request to /mount/types

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn mount_unmount<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, mount_point: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Sends a POST request to /mount/unmount

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• mount_point: Local mount point path to unmount.

pub async fn mount_unmountall<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Sends a POST request to /mount/unmountall

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn rc_noop_auth<'a>( &'a self, async_: Option<bool>, params: Option<&'a Map<String, Value>>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Echo parameters (auth required)

Same as rc/noop, but requires authentication to validate access control.

Sends a POST request to /rc/noopauth

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• params: Additional arbitrary parameters allowed.

pub async fn rc_error<'a>( &'a self, async_: Option<bool>, params: Option<&'a Map<String, Value>>, ) -> Result<ResponseValue<()>, Error<RcError>>

Return a test error

Always returns an error response incorporating the supplied parameters, useful for testing error handling.

Sends a POST request to /rc/error

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• params: Additional arbitrary parameters allowed.

pub async fn rc_list<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<RcListResponse>, Error<RcError>>

List RC commands

Returns metadata about every available RC command, including whether authentication is required.

Sends a POST request to /rc/list

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn backend_command<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, arg: Option<&'a Vec<String>>, command: &'a str, fs: Option<&'a str>, opt: Option<&'a str>, ) -> Result<ResponseValue<BackendCommandResponse>, Error<RcError>>

Run backend command

Invokes a backend-specific management command against an optional remote.

Sends a POST request to /backend/command

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• arg: Optional positional arguments for the backend command.
• command: Backend-specific command to invoke.
• fs: Remote name or path the backend command should target.
• opt: Backend command options encoded as a JSON string.

pub async fn cache_expire<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, remote: &'a str, with_data: Option<bool>, ) -> Result<ResponseValue<()>, Error<RcError>>

Expire cache entries

Drops cached directory entries, and optionally cached file data, for the cache backend.

Sends a POST request to /cache/expire

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• remote: Remote path to expire from the cache, e.g. remote:path/to/dir.
• with_data: Set to true to drop cached chunk data along with directory entries.

pub async fn cache_fetch<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, chunks: Option<&'a str>, params: Option<&'a Map<String, Value>>, ) -> Result<ResponseValue<()>, Error<RcError>>

Prefetch cache chunks

Ensures specified file chunks are cached locally for a cache remote.

Sends a POST request to /cache/fetch

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• chunks: Comma-separated chunk specifier list (e.g. 0:10,25:30) describing file pieces to prefetch.
• params: Additional arbitrary parameters allowed.

pub async fn cache_stats<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<()>, Error<RcError>>

Show cache stats

Returns runtime statistics for the cache backend.

Sends a POST request to /cache/stats

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn config_create<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, name: &'a str, opt: Option<&'a str>, parameters: &'a str, type_: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Create remote configuration

Creates a new remote in rclone.conf, mirroring rclone config create.

Sends a POST request to /config/create

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• name: Name of the new remote configuration.
• opt: Optional JSON object controlling interactive behaviour (e.g. obscure, continue).
• parameters: JSON object of configuration key/value pairs required for the remote.
• type_: Backend type identifier, such as drive, s3, or dropbox.

pub async fn config_delete<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, name: &'a str, ) -> Result<ResponseValue<()>, Error<RcError>>

Delete remote configuration

Removes an existing remote from rclone.conf.

Sends a POST request to /config/delete

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• name: Name of the remote configuration to delete.

pub async fn config_dump<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<HashMap<String, HashMap<String, String>>>, Error<RcError>>

Dump configuration

Returns the contents of the config file as a JSON object keyed by remote name.

Sends a POST request to /config/dump

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn config_get<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, name: &'a str, ) -> Result<ResponseValue<ConfigGetResponse>, Error<RcError>>

Get remote configuration

Returns the key/value settings for a single remote.

Sends a POST request to /config/get

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• name: Name of the remote configuration to fetch.

pub async fn config_listremotes<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<ConfigListremotesResponse>, Error<RcError>>

List configured remotes

Returns the names of all remotes defined in the config file.

Sends a POST request to /config/listremotes

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn config_password<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, name: &'a str, parameters: &'a str, ) -> Result<ResponseValue<()>, Error<RcError>>

Update remote secrets

Sets obscured password fields for a remote configuration.

Sends a POST request to /config/password

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• name: Name of the remote whose secrets should be updated.
• parameters: JSON object of password answers, typically including pass.

pub async fn config_paths<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<ConfigPathsResponse>, Error<RcError>>

Show config paths

Returns the paths to the config file, cache directory, and temporary directory.

Sends a POST request to /config/paths

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn config_providers<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<ConfigProvidersResponse>, Error<RcError>>

List backend providers

Returns metadata describing each supported storage provider.

Sends a POST request to /config/providers

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn config_setpath<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, path: &'a str, ) -> Result<ResponseValue<()>, Error<RcError>>

Set config path

Points rclone at a specific rclone.conf file.

Sends a POST request to /config/setpath

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• path: Absolute path to the rclone.conf file that rclone should use.

pub async fn config_unlock<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, config_password: &'a str, ) -> Result<ResponseValue<()>, Error<RcError>>

Unlock encrypted config

Unlocks the configuration file using the provided password.

Sends a POST request to /config/unlock

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• config_password: Password used to unlock an encrypted config file.

pub async fn config_update<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, name: &'a str, opt: Option<&'a str>, parameters: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Update remote configuration

Updates an existing remote with new parameter values.

Sends a POST request to /config/update

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• name: Name of the remote configuration to update.
• opt: Optional JSON object controlling update behaviour (e.g. obscure, continue).
• parameters: JSON object of configuration key/value pairs to apply to the remote.

pub async fn core_version<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<CoreVersionResponse>, Error<RcError>>

Report rclone version

Returns the running rclone version, build metadata, and Go runtime details.

Sends a POST request to /core/version

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn core_stats<'a>( &'a self, async_: Option<bool>, _group: Option<&'a str>, group: Option<&'a str>, short: Option<bool>, ) -> Result<ResponseValue<CoreStatsResponse>, Error<RcError>>

Current stats snapshot

Returns active transfer statistics including bytes transferred, speed, and error counts.

Sends a POST request to /core/stats

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• group: Stats group identifier to return a snapshot for. Leave unset to include all groups.
• short: When true, omit the transferring and checking arrays from the response.

pub async fn job_list<'a>( &'a self, async_: Option<bool>, ) -> Result<ResponseValue<JobListResponse>, Error<RcError>>

List jobs

Returns identifiers of active and recently completed asynchronous jobs.

Sends a POST request to /job/list

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.

pub async fn job_status<'a>( &'a self, async_: Option<bool>, jobid: f64, ) -> Result<ResponseValue<JobStatusResponse>, Error<RcError>>

Get job status

Returns timing, success state, output, and progress for a specific job.

Sends a POST request to /job/status

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• jobid: Numeric identifier of the job to query, as returned from an async call.

pub async fn job_stop<'a>( &'a self, async_: Option<bool>, jobid: f64, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Stop job

Attempts to cancel a running job by ID.

Sends a POST request to /job/stop

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• jobid: Numeric identifier of the job to cancel.

pub async fn job_stopgroup<'a>( &'a self, async_: Option<bool>, group: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Stop jobs in group

Cancels all active jobs associated with the provided stats group.

Sends a POST request to /job/stopgroup

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Stats group name whose active jobs should be stopped.

pub async fn operations_list<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, dirs_only: Option<bool>, files_only: Option<bool>, fs: &'a str, hash_types: Option<&'a Vec<String>>, metadata: Option<bool>, no_mime_type: Option<bool>, no_mod_time: Option<bool>, opt: Option<&'a str>, recurse: Option<bool>, remote: &'a str, show_encrypted: Option<bool>, show_hash: Option<bool>, show_orig_i_ds: Option<bool>, ) -> Result<ResponseValue<OperationsListResponse>, Error<RcError>>

List objects

Lists objects and directories for a remote path, returning the same fields as rclone lsjson.

Sends a POST request to /operations/list

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• dirs_only: Set to true to return only directory entries.
• files_only: Set to true to return only file entries.
• fs: Remote name or path to list, for example drive:.
• hash_types: Specify one or more hash algorithms to include when showHash is true (e.g. md5).
• metadata: Set to true to include backend-provided metadata maps.
• no_mime_type: Set to true to omit MIME type detection.
• no_mod_time: Set to true to omit modification times for faster listings on some backends.
• opt: Optional JSON-encoded object of listing flags (e.g. { "recurse": true, "showHash": true }).
• recurse: Set to true to list directories recursively.
• remote: Directory path within fs to list; leave empty to target the root.
• show_encrypted: Set to true to include encrypted names when using crypt remotes.
• show_hash: Set to true to include hash digests for each entry.
• show_orig_i_ds: Set to true to include original backend identifiers where available.

pub async fn operations_stat<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, opt: Option<&'a str>, remote: &'a str, ) -> Result<ResponseValue<OperationsStatResponse>, Error<RcError>>

Stat an object

Returns metadata for a single file or directory, mirroring rclone lsjson on one entry.

Sends a POST request to /operations/stat

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path that contains the item to inspect.
• opt: Optional JSON object of listing flags, matching those accepted by operations/list.
• remote: Path to the file or directory within fs to describe.

pub async fn operations_about<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, ) -> Result<ResponseValue<OperationsAboutResponse>, Error<RcError>>

Get remote quota

Returns storage quota and usage details for the remote, equivalent to rclone about.

Sends a POST request to /operations/about

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path to query for capacity information.

pub async fn operations_uploadfile<'a, B: Into<Body>>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, remote: &'a str, body: B, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Upload files via multipart

Accepts multipart/form-data payloads and writes the uploaded files to the specified remote path.

Sends a POST request to /operations/uploadfile

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path where the uploaded file should be stored.
• remote: Destination path within fs for the uploaded file.
• body: Multipart form payload containing one or more files to upload.

pub async fn operations_purge<'a>( &'a self, async_: Option<bool>, config: Option<&'a str>, filter: Option<&'a str>, group: Option<&'a str>, fs: &'a str, remote: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Purge directory

Deletes a directory or container and all of its contents.

Sends a POST request to /operations/purge

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• config: JSON encoded config overrides applied for this call only.
• filter: JSON encoded filter overrides applied for this call only.
• group: Assign the request to a custom stats group.
• fs: Remote name or path from which to remove all contents.
• remote: Path within fs whose contents should be purged.

pub async fn operations_mkdir<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, remote: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Create directory

Creates the target directory or container if it does not exist.

Sends a POST request to /operations/mkdir

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path in which to create a directory.
• remote: Directory path within fs to create.

pub async fn operations_rmdir<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: &'a str, remote: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Remove empty directory

Deletes an empty directory or container.

Sends a POST request to /operations/rmdir

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Remote name or path containing the directory to remove.
• remote: Directory path within fs to delete.

pub async fn operations_check<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, check_file_fs: Option<&'a str>, check_file_hash: Option<&'a str>, check_file_remote: Option<&'a str>, combined: Option<bool>, differ: Option<bool>, download: Option<bool>, dst_fs: &'a str, error: Option<bool>, match_: Option<bool>, missing_on_dst: Option<bool>, missing_on_src: Option<bool>, one_way: Option<bool>, src_fs: &'a str, ) -> Result<ResponseValue<OperationsCheckResponse>, Error<RcError>>

Compare source and destination

Compares source and destination trees, reporting matches, differences, and missing files.

Sends a POST request to /operations/check

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• check_file_fs: Remote containing the checksum SUM file when using checkFileHash.
• check_file_hash: Hash name to expect in the supplied SUM file, such as md5.
• check_file_remote: Path within checkFileFs to the checksum SUM file.
• combined: Set to true to include a combined summary report in the response.
• differ: Set to true to include differing files in the report.
• download: Set to true to read file contents during comparison instead of relying on hashes.
• dst_fs: Destination remote name or path that should match the source.
• error: Set to true to include entries that encountered errors.
• match_: Set to true to include matching files in the report.
• missing_on_dst: Set to true to report files missing from the destination.
• missing_on_src: Set to true to report files missing from the source.
• one_way: Set to true to only ensure that source files exist on the destination.
• src_fs: Source remote name or path to verify, e.g. drive:.

pub async fn sync_sync<'a>( &'a self, async_: Option<bool>, config: Option<&'a str>, filter: Option<&'a str>, group: Option<&'a str>, create_empty_src_dirs: Option<bool>, dst_fs: &'a str, src_fs: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Sync source to destination

Synchronises a source remote to a destination remote, making the destination match the source.

Sends a POST request to /sync/sync

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• config: JSON encoded config overrides applied for this call only.
• filter: JSON encoded filter overrides applied for this call only.
• group: Assign the request to a custom stats group.
• create_empty_src_dirs: Set to true to create empty source directories on the destination.
• dst_fs: Destination remote path to sync to, e.g. drive:dst.
• src_fs: Source remote path to sync from, e.g. drive:src.

pub async fn sync_copy<'a>( &'a self, async_: Option<bool>, config: Option<&'a str>, filter: Option<&'a str>, group: Option<&'a str>, create_empty_src_dirs: Option<bool>, dst_fs: &'a str, src_fs: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Copy source to destination

Copies objects from a source remote to a destination remote without deleting destination files.

Sends a POST request to /sync/copy

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• config: JSON encoded config overrides applied for this call only.
• filter: JSON encoded filter overrides applied for this call only.
• group: Assign the request to a custom stats group.
• create_empty_src_dirs: Set to true to replicate empty source directories on the destination.
• dst_fs: Destination remote path to copy to.
• src_fs: Source remote path to copy from.

pub async fn sync_move<'a>( &'a self, async_: Option<bool>, config: Option<&'a str>, filter: Option<&'a str>, group: Option<&'a str>, create_empty_src_dirs: Option<bool>, delete_empty_src_dirs: Option<bool>, dst_fs: &'a str, src_fs: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Move source to destination

Moves objects from a source remote to a destination remote, optionally cleaning up empty directories.

Sends a POST request to /sync/move

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• config: JSON encoded config overrides applied for this call only.
• filter: JSON encoded filter overrides applied for this call only.
• group: Assign the request to a custom stats group.
• create_empty_src_dirs: Set to true to create empty source directories on the destination.
• delete_empty_src_dirs: Set to true to delete empty directories from the source after the move completes.
• dst_fs: Destination remote path that will receive moved files.
• src_fs: Source remote path whose contents will be moved.

pub async fn sync_bisync<'a>( &'a self, async_: Option<bool>, config: Option<&'a str>, filter: Option<&'a str>, group: Option<&'a str>, backupdir1: Option<&'a str>, backupdir2: Option<&'a str>, check_access: Option<bool>, check_filename: Option<&'a str>, check_sync: Option<bool>, create_empty_src_dirs: Option<bool>, dry_run: Option<bool>, filters_file: Option<&'a str>, force: Option<bool>, ignore_listing_checksum: Option<bool>, max_delete: Option<f64>, no_cleanup: Option<bool>, path1: &'a str, path2: &'a str, remove_empty_dirs: Option<bool>, resilient: Option<bool>, resync: Option<bool>, workdir: Option<&'a str>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Bidirectional sync

Performs a bidirectional synchronisation between two paths, supporting safety checks and recovery options.

Sends a POST request to /sync/bisync

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• config: JSON encoded config overrides applied for this call only.
• filter: JSON encoded filter overrides applied for this call only.
• group: Assign the request to a custom stats group.
• backupdir1: Backup directory on the first remote for changed files.
• backupdir2: Backup directory on the second remote for changed files.
• check_access: Set to true to abort if RCLONE_TEST files are missing on either side.
• check_filename: Override the access-check sentinel filename; defaults to RCLONE_TEST.
• check_sync: Controls final listing comparison; leave true for normal verification or set false to skip.
• create_empty_src_dirs: Set to true to mirror empty directories between the two paths.
• dry_run: Set to true to simulate the bisync run without making changes.
• filters_file: Path to an rclone filters file applied to both paths.
• force: Set to true to bypass the maxDelete safety check.
• ignore_listing_checksum: Set to true to ignore checksum differences when comparing listings.
• max_delete: Abort the run if deletions exceed this percentage (default 50).
• no_cleanup: Set to true to keep bisync working files after completion.
• path1: First remote directory, e.g. drive:path1.
• path2: Second remote directory, e.g. drive:path2.
• remove_empty_dirs: Set to true to remove empty directories during cleanup.
• resilient: Set to true to allow retrying after certain recoverable errors.
• resync: Set to true to perform a one-time resync, rebuilding bisync history.
• workdir: Directory path used to store bisync working files.

pub async fn options_blocks<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<OptionsBlocksResponse>, Error<RcError>>

List option blocks

Returns the names of option blocks that can be queried or updated.

Sends a POST request to /options/blocks

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn options_get<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, blocks: Option<&'a str>, ) -> Result<ResponseValue<OptionsGetResponse>, Error<RcError>>

Get option values

Returns the current global option values, optionally filtered by block.

Sends a POST request to /options/get

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• blocks: Optional comma-separated list of option block names to return.

pub async fn options_info<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, blocks: Option<&'a str>, ) -> Result<ResponseValue<OptionsInfoResponse>, Error<RcError>>

Describe options

Returns metadata for options, including help text and defaults, grouped by block.

Sends a POST request to /options/info

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• blocks: Optional comma-separated list of option block names to describe.

pub async fn options_set<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, dlna: Option<&'a HashMap<String, OptionsSetDlnaValue>>, filter: Option<&'a HashMap<String, OptionsSetFilterValue>>, ftp: Option<&'a HashMap<String, OptionsSetFtpValue>>, http: Option<&'a HashMap<String, OptionsSetHttpValue>>, log: Option<&'a HashMap<String, OptionsSetLogValue>>, main: Option<&'a HashMap<String, OptionsSetMainValue>>, mount: Option<&'a HashMap<String, OptionsSetMountValue>>, nfs: Option<&'a HashMap<String, OptionsSetNfsValue>>, proxy: Option<&'a HashMap<String, OptionsSetProxyValue>>, rc: Option<&'a HashMap<String, OptionsSetRcValue>>, restic: Option<&'a HashMap<String, OptionsSetResticValue>>, s3: Option<&'a HashMap<String, OptionsSetS3Value>>, sftp: Option<&'a HashMap<String, OptionsSetSftpValue>>, vfs: Option<&'a HashMap<String, OptionsSetVfsValue>>, webdav: Option<&'a HashMap<String, OptionsSetWebdavValue>>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Set option values

Sets temporary option overrides for the running process by supplying key/value pairs grouped under option block names. Provide one or more query parameters whose names match the blocks you want to modify (for example main, rc, http). Each block parameter carries an object of option overrides.

Sends a POST request to /options/set

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• dlna: Overrides for the dlna option block.
• filter: Overrides for the filter option block.
• ftp: Overrides for the ftp option block.
• http: Overrides for the http option block.
• log: Overrides for the log option block.
• main: Overrides for the main option block.
• mount: Overrides for the mount option block.
• nfs: Overrides for the nfs option block.
• proxy: Overrides for the proxy option block.
• rc: Overrides for the rc option block.
• restic: Overrides for the restic option block.
• s3: Overrides for the s3 option block.
• sftp: Overrides for the sftp option block.
• vfs: Overrides for the vfs option block.
• webdav: Overrides for the webdav option block.

pub async fn options_local<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<OptionsLocalResponse>, Error<RcError>>

Show effective options

Returns the current effective options for this request, including _config and _filter overrides.

Sends a POST request to /options/local

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn serve_list<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<ServeListResponse>, Error<RcError>>

List serve instances

Returns all running rclone serve instances with their IDs and options.

Sends a POST request to /serve/list

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn serve_start<'a>( &'a self, async_: Option<bool>, config: Option<&'a str>, filter: Option<&'a str>, group: Option<&'a str>, addr: &'a str, fs: &'a str, params: Option<&'a Map<String, Value>>, type_: &'a str, ) -> Result<ResponseValue<ServeStartResponse>, Error<RcError>>

Start serve instance

Launches a new rclone serve endpoint (http, webdav, ftp, etc.) with the provided parameters.

Sends a POST request to /serve/start

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• config: JSON encoded config overrides applied for this call only.
• filter: JSON encoded filter overrides applied for this call only.
• group: Assign the request to a custom stats group.
• addr: Address and port to bind the server to, such as :5572 or localhost:8080.
• fs: Remote path that will be served.
• params: Additional arbitrary parameters allowed.
• type_: Type of server to start (e.g. http, webdav, ftp, sftp).

pub async fn serve_stop<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, id: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Stop serve instance

Stops a running serve instance identified by its ID.

Sends a POST request to /serve/stop

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• id: Identifier of the running serve instance returned by serve/start.

pub async fn serve_stopall<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Stop all serve instances

Stops every active serve instance.

Sends a POST request to /serve/stopall

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn serve_types<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<()>, Error<RcError>>

List serve types

Returns the list of supported rclone serve protocols.

Sends a POST request to /serve/types

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn vfs_forget<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: Option<&'a str>, params: Option<&'a Map<String, Value>>, ) -> Result<ResponseValue<VfsForgetResponse>, Error<RcError>>

Forget cached paths

Evicts specific files or directories from the VFS directory cache.

Sends a POST request to /vfs/forget

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Optional VFS identifier to target; required when more than one VFS is active.
• params: Additional arbitrary parameters allowed.

pub async fn vfs_list<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: Option<&'a str>, ) -> Result<ResponseValue<VfsListResponse>, Error<RcError>>

List VFS instances

Lists the active VFS instances and their identifiers.

Sends a POST request to /vfs/list

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Optional VFS identifier; omit to list all active VFS instances.

pub async fn vfs_poll_interval<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: Option<&'a str>, interval: Option<&'a str>, timeout: Option<&'a str>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Get or set poll interval

Reads or updates the VFS poll interval duration, optionally waiting for the change to apply.

Sends a POST request to /vfs/poll-interval

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Optional VFS identifier whose poll interval should be queried or modified.
• interval: Duration string (e.g. 5m) to set as the new poll interval.
• timeout: Duration to wait for the poll interval change to take effect; 0 waits indefinitely.

pub async fn vfs_queue<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: Option<&'a str>, ) -> Result<ResponseValue<VfsQueueResponse>, Error<RcError>>

Inspect upload queue

Returns the contents of the VFS upload queue.

Sends a POST request to /vfs/queue

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Optional VFS identifier whose upload queue should be inspected.

pub async fn vfs_queue_set_expiry<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, expiry: f64, fs: Option<&'a str>, id: i64, relative: Option<bool>, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Adjust queue expiry

Sets the expiry time of a queued VFS upload item, optionally relative to its current value.

Sends a POST request to /vfs/queue-set-expiry

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• expiry: New eligibility time in seconds (may be negative for immediate upload).
• fs: Optional VFS identifier for the queued item.
• id: Queue item ID as returned by vfs/queue.
• relative: Set to true to treat expiry as relative to the current value.

pub async fn vfs_refresh<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: Option<&'a str>, params: Option<&'a Map<String, Value>>, recursive: Option<bool>, ) -> Result<ResponseValue<VfsRefreshResponse>, Error<RcError>>

Refresh directory cache

Refreshes one or more directories in the VFS cache, optionally recursively.

Sends a POST request to /vfs/refresh

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Optional VFS identifier whose directory cache should be refreshed.
• params: Additional arbitrary parameters allowed.
• recursive: Set to true to refresh entire directory trees.

pub async fn vfs_stats<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, fs: Option<&'a str>, ) -> Result<ResponseValue<VfsStatsResponse>, Error<RcError>>

Show VFS stats

Returns VFS statistics including disk cache usage and metadata cache counters.

Sends a POST request to /vfs/stats

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• fs: Optional VFS identifier whose statistics should be returned.

pub async fn pluginsctl_add_plugin<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, url: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<RcError>>

Install plugin

Downloads and installs a plugin into the WebUI from the provided repository URL.

Sends a POST request to /pluginsctl/addPlugin

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• url: Repository URL of the plugin to install.

pub async fn pluginsctl_get_plugins_for_type<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, plugin_type: Option<&'a str>, type_: Option<&'a str>, ) -> Result<ResponseValue<PluginsctlGetPluginsForTypeResponse>, Error<RcError>>

Filter plugins by MIME type

Returns plugins matching the requested MIME type and optional plugin type.

Sends a POST request to /pluginsctl/getPluginsForType

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• plugin_type: Filter results by plugin type (e.g. test).
• type_: MIME type to match when listing plugins.

pub async fn pluginsctl_list_plugins<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<PluginsctlListPluginsResponse>, Error<RcError>>

List installed plugins

Returns metadata for installed production and test plugins.

Sends a POST request to /pluginsctl/listPlugins

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn pluginsctl_list_test_plugins<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, ) -> Result<ResponseValue<PluginsctlListTestPluginsResponse>, Error<RcError>>

List installed test plugins

Returns metadata for installed test plugins.

Sends a POST request to /pluginsctl/listTestPlugins

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.

pub async fn pluginsctl_remove_plugin<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, name: &'a str, ) -> Result<ResponseValue<()>, Error<RcError>>

Remove plugin

Uninstalls a plugin from the WebUI.

Sends a POST request to /pluginsctl/removePlugin

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• name: Name of the plugin to uninstall.

pub async fn pluginsctl_remove_test_plugin<'a>( &'a self, async_: Option<bool>, group: Option<&'a str>, name: &'a str, ) -> Result<ResponseValue<()>, Error<RcError>>

Remove test plugin

Uninstalls a test plugin from the WebUI.

Sends a POST request to /pluginsctl/removeTestPlugin

Arguments:

• async_: Run the command asynchronously. Returns a job id immediately.
• group: Assign the request to a custom stats group.
• name: Name of the test plugin to uninstall.

Trait Implementations

impl ClientHooks for &Client

async fn pre<E>( &self, request: &mut Request, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs prior to the execution of the request. This may be used to modify the request before it is transmitted.

async fn post<E>( &self, result: &Result<Response, Error>, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs after completion of the request.

async fn exec( &self, request: Request, info: &OperationInfo, ) -> Result<Response, Error>

Execute the request. Note that for almost any reasonable implementation this will include code equivalent to this:

impl ClientInfo<()> for Client

fn api_version() -> &'static str

Get the version of this API.

fn baseurl(&self) -> &str

Get the base URL to which requests are made.

fn client(&self) -> &Client

Get the internal reqwest::Client used to make requests.

fn inner(&self) -> &()

Get the inner value of type T if one is specified.

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.