Expand description
Typed input/output models for the Deluge daemon RPC protocol.
Structs§
- Account
Info - User account info returned by
core.get_known_accounts(). - AddTorrent
Options - Options dict for
core.add_torrent_*methods andcore.set_torrent_options. - Auto
AddConfig - Configuration for the AutoAdd plugin.
- Blocklist
Config - Configuration for the Blocklist plugin.
- Blocklist
Status - Current import status of the Blocklist plugin.
- Completion
Paths - Input and return shape for
core.get_completion_paths(). - Create
Torrent Request - Request for
core.create_torrent. - Create
Torrent Result - Result of
core.create_torrent(). - Daemon
Config - All daemon config preferences returned by
core.get_config(). - Execute
Command - A command registered with the Execute plugin.
- Extractor
Config - Configuration for the Extractor plugin.
- File
Info - File entry, from the
files/orig_filessub-dict ofTorrentStatus. - Filter
Dict - Filter dict for
core.get_torrents_status. - Filter
Tree Entry - A single entry in the filter tree:
(value: str, count: int). - Handled
Event - An event that the Notifications plugin can handle.
- Label
Config - Global configuration for the Label plugin.
- Label
Options - Per-label options applied to torrents with that label.
- Notifications
Config - Configuration for the Notifications plugin.
- Peer
Info - Connected peer, from the
peerssub-dict ofTorrentStatus. - Prefetch
Magnet Result - Return of
core.prefetch_magnet_metadata. Tuple of(torrent_id, metadata)wheremetadatais bencoded torrent data. - Proxy
Config - Proxy configuration nested inside
DaemonConfig. - Scheduler
Config - Configuration for the Scheduler plugin.
- Session
Status - Session status returned by
core.get_session_status(keys). - Stats
Config - Configuration for the Stats plugin.
- Stats
GetStats Result - Return value of
stats.get_stats. - Stats
Totals - Cumulative totals returned by
stats.get_totalsandstats.get_session_totals. - Torrent
Entry - A single torrent’s data as returned by
core.get_torrents_status. The outer dict key (torrent_id) is captured ininfo_hash; the inner status dict is flattened intostatus. - Torrent
Status - Status of a single torrent, returned by
core.get_torrent_status/core.get_torrents_status. - Tracker
Info - Tracker entry, from the
trackerssub-dict ofTorrentStatus. - Watch
DirOptions - Options for a single AutoAdd watch directory.
- WebUi
Config - Configuration for the WebUi plugin.
Enums§
- Deluge
Event - A typed Deluge daemon event.
- Execute
Event - Torrent events that can trigger an Execute command.
- Scheduler
State - Current schedule state returned by
scheduler.get_state. - Torrent
Format - Torrent metadata format for
core.create_torrent.
Type Aliases§
- AddTorrent
File Result - Return of
core.add_torrent_file/core.add_torrent_file_async/core.add_torrent_url.Noneon failure,Some(torrent_id)on success. - AddTorrent
Files Result - Return of
core.add_torrent_files. Each element is an error message for a torrent that failed to add. Empty list = all succeeded. - Filter
Tree - Return of
core.get_filter_tree:{field: [(value, count), ...]}. - GetMagnet
UriResult - Return of
core.get_magnet_uri. - Glob
Result - Result of
core.glob(path). Returns a list of filesystem paths matching the glob pattern. - Remove
Torrents Result - Return of
core.remove_torrents. Each tuple is(torrent_id, error_message)for failed removals. Empty list = all succeeded. - SetTorrent
Options - Options for
core.set_torrent_options. Same keys asAddTorrentOptions. - Watch
DirId - Numeric identifier for a watch directory.