qbit

KO | EN

gitlite — search

#python #hacktoberfest #typescript #golang #linux #docker #nodejs #java #windows #vue #security #pytorch #ios #openai

(★ 67)

A Rust library for interacting with qBittorrent's Web API

qbit 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Qbit-rs

[<img alt="crates.io" src="https://img.shields.io/crates/v/qbit-rs?style=for-the-badge&labelColor=555555&color=FFD3B6&logo=rust" height="20">](https://crates.io/crates/qbit-rs)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-qbit--rs-DCEDC1?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/qbit-rs)
[<img alt="github" src="https://img.shields.io/badge/github-George--Miao-A8E6CF?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/George-Miao/qbit)

A Rust library for interacting with qBittorrent's Web API.

Implemented according to the official [WebUI API (qBittorrent 5.0+)](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)).
The crate also supports endpoints introduced through qBittorrent 5.2 (Web API v2.16.0), including features not yet covered by the official reference.
For the most accurate and complete list of supported API methods and model fields, please refer to this [crate's documentation on docs.rs](https://docs.rs/qbit-rs/latest/qbit_rs/).

## Usage

Add dependency by running:

```bash
cargo add qbit-rs
```

or manually add to `Cargo.toml`:

```toml
[dependencies]
qbit-rs = "0.5"
```

## Authentication

### Username and password

With WebUI credentials, `Qbit` logs in automatically and renews the session if
its cookie expires:

```rust,ignore
use qbit_rs::Qbit;
use qbit_rs::model::Credential;

let credential = Credential::new("username", "password");
let api = Qbit::new("http://my-qb-instance.domain", credential);
let version = api.get_version().await;
```

### Cookie

To reuse an existing WebUI session, provide its SID cookie:

```rust,ignore
use qbit_rs::Qbit;

let api = Qbit::builder()
    .endpoint("http://my-qb-instance.domain")
    .cookie("SID=1234567890")
    .build();
let version = api.get_version().await;
```

### API key

qBittorrent 5.2 and newer versions support stateless API-key authentication.
`Qbit` adds the required `Bearer` authorization scheme automatically:

```rust,ignore
use qbit_rs::Qbit;

let api = Qbit::builder()
    .endpoint("http://my-qb-instance.domain")
    .api_key("qbt_your_api_key")
    .build();
let version = api.get_version().await;
```

API keys cannot access the WebUI's static assets or authentication endpoints
such as `login` and `logout`.

## HTTP Client

The crate by default uses `reqwest` as the HTTP client. It also supports [`cyper`](https://github.com/compio-rs/cyper) (HTTP client for [`compio`](https://github.com/compio-rs/compio) based on hyper) under the `cyper` feature flag. To use it, disable default features and enable `cyper`:

```bash
cargo add qbit-rs --no-default-features --features cyper
```

Notice that this will also disable tls and `typed-builder` support for args. Make sure to enable `builder`, `native-tls` or `rustls-tls` if you need them.

## API Coverage

For all methods, see [`Qbit`](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html).

The authentication, application, log, sync, transfer, torrent-management, RSS, and Search APIs are covered.

1. [x] Authentication
   1. [x] [Login](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.login)
   1. [x] [Logout](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.logout)
   1. [x] [API key authentication](#api-key)
   1. [x] [Get current cookie](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_cookie)
1. [x] Application
   1. [x] [Get application version](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_version)
   1. [x] [Get API version](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_webapi_version)
   1. [x] [Get build info](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_build_info)
   1. [x] [Get process info](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_process_info)
   1. [x] [Shutdown application](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.shutdown)
   1. [x] [Get application preferences](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_preferences)
   1. [x] [Set application preferences](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_preferences)
   1. [x] [Get free space at path](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_free_space_at_path)
   1. [x] [Get default save path](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_default_save_path)
   1. [x] [Get cookies](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_cookies)
   1. [x] [Set cookies](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_cookies)
1. [x] Log
   1. [x] [Get log](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_logs)
   1. [x] [Get peer log](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_peer_logs)
1. [x] Sync
   1. [x] [Get main data](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.sync)
   1. [x] [Get torrent peers data](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_peers)
1. [x] Transfer info
   1. [x] [Get global transfer info](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_transfer_info)
   1. [x] [Get alternative speed limits state](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_speed_limits_mode)
   1. [x] [Toggle alternative speed limits](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.toggle_speed_limits_mode)
   1. [x] [Get global and alternative speed limits](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_speed_limits)
   1. [x] [Set global and alternative speed limits](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_speed_limits)
   1. [x] [Get global download limit](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_download_limit)
   1. [x] [Set global download limit](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_download_limit)
   1. [x] [Get global upload limit](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_upload_limit)
   1. [x] [Set global upload limit](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_upload_limit)
   1. [x] [Ban peers](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.ban_peers)
1. [x] Torrent management
   1. [x] [Get torrent list](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_list)
   1. [x] [Download torrent file](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.download_torrent_file)
   1. [x] [Get torrent generic properties](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_properties)
   1. [x] [Get torrent piece availability](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_piece_availability)
   1. [x] [Get torrent trackers](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_trackers)
   1. [x] [Get torrent web seeds](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_web_seeds)
   1. [x] [Get torrent contents](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_contents)
   1. [x] [Get torrent pieces' states](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_pieces_states)
   1. [x] [Get torrent pieces' hashes](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_pieces_hashes)
   1. [x] [Add new torrent](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.add_torrent)
   1. [x] [Stop torrents](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.stop_torrents)
   1. [x] [Start torrents](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.start_torrents)
   1. [x] [Delete torrents](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.delete_torrents)
   1. [x] [Recheck torrents](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.recheck_torrents)
   1. [x] [Reannounce torrents](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.reannounce_torrents)
   1. [x] [Reannounce torrents with selected trackers](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.reannounce_torrents_with_trackers)
   1. [x] [Edit trackers](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.edit_trackers)
   1. [x] [Remove trackers](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.remove_trackers)
   1. [x] [Add peers](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.add_peers)
   1. [x] [Add trackers to torrent](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.add_trackers)
   1. [x] [Increase torrent priority](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.increase_priority)
   1. [x] [Decrease torrent priority](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.decrease_priority)
   1. [x] [Maximal torrent priority](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.maximal_priority)
   1. [x] [Minimal torrent priority](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.minimal_priority)
   1. [x] [Set file priority](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_file_priority)
   1. [x] [Get torrent download limit](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_download_limit)
   1. [x] [Set torrent download limit](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_torrent_download_limit)
   1. [x] [Set torrent share limit](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_torrent_shared_limit)
   1. [x] [Get torrent upload limit](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_torrent_upload_limit)
   1. [x] [Set torrent upload limit](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_torrent_upload_limit)
   1. [x] [Set torrent location](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_torrent_location)
   1. [x] [Set torrent name](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_torrent_name)
   1. [x] [Set torrent comment](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_torrent_comment)
   1. [x] [Set torrent category](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_torrent_category)
   1. [x] [Get all categories](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_categories)
   1. [x] [Add new category](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.add_category)
   1. [x] [Edit category](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.edit_category)
   1. [x] [Remove categories](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.remove_categories)
   1. [x] [Add torrent tags](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.add_torrent_tags)
   1. [x] [Remove torrent tags](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.remove_torrent_tags)
   1. [x] [Get all tags](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_all_tags)
   1. [x] [Create tags](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.create_tags)
   1. [x] [Delete tags](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.delete_tags)
   1. [x] [Set automatic torrent management](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_auto_management)
   1. [x] [Toggle sequential download](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.toggle_sequential_download)
   1. [x] [Set first/last piece priority](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.toggle_first_last_piece_priority)
   1. [x] [Set force start](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_force_start)
   1. [x] [Set super seeding](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_super_seeding)
   1. [x] [Rename file](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.rename_file)
   1. [x] [Rename folder](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.rename_folder)
1. [x] RSS (experimental)
   1. [x] [Add folder](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.add_folder)
   1. [x] [Add feed](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.add_feed)
   1. [x] [Remove item](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.remove_item)
   1. [x] [Move item](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.move_item)
   1. [x] [Get all items](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_rss_items)
   1. [x] [Mark as read](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.mark_as_read)
   1. [x] [Refresh item](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.refresh_item)
   1. [x] [Set auto-downloading rule](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.set_rule)
   1. [x] [Rename auto-downloading rule](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.rename_rule)
   1. [x] [Remove auto-downloading rule](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.remove_rule)
   1. [x] [Get all auto-downloading rules](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_rules)
   1. [x] [Get all articles matching a rule](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_matching_articles)
1. [x] Search
   1. [x] [Start search](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.start_search)
   1. [x] [Stop search](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.stop_search)
   1. [x] [Get search status](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_search_status)
   1. [x] [Get search results](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_search_results)
   1. [x] [Delete search](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.delete_search)
   1. [x] [Get search plugins](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.get_search_plugins)
   1. [x] [Install search plugin](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.install_search_plugins)
   1. [x] [Uninstall search plugin](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.uninstall_search_plugins)
   1. [x] [Enable search plugin](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.enable_search_plugins)
   1. [x] [Update search plugins](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.update_search_plugins)
1. Undocumented
   1. [x] [Export torrent](https://docs.rs/qbit-rs/latest/qbit_rs/struct.Qbit.html#method.export_torrent)[^1]

[^1]: The endpoint is added in [this PR](https://github.com/qbittorrent/qBittorrent/pull/16968)

qbit

qbit 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

qbit

qbit 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README