qbit-api-rs

qBittorrent Web API (适用于4.1以上版本)的异步Rust封装

使用方法

添加依赖项

[dependencies]
qbit-api-rs = "0.1"

或者

cargo add qbit-api-rs

快速入门

use qbit_api_rs::client::QbitClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // initialize client with given username and password
    let client = QbitClient::new_with_user_pwd("http://hostname:port", "admin", "adminadmin").unwrap();
    // or from environment variable
    // QBIT_HOST, QBIT_USERNAME, QBIT_PASSWORD must be set
    let client = QbitClient::new_from_env().unwrap();

    // login first
    client.auth_login().await?;

    // call api methods
    println!("{}", client.app_version().await?);

    //...
    Ok(())
}

更多使用方法，请参阅示例。

注意

• 此crate仅提供纯API绑定。没有像令牌过期时重新认证这样的机制。

• qBitTorrent使用cookie进行认证。所需SID令牌存储在cookie中，一段时间后（默认3600秒）将过期。此过期时间可以在Options -> WebUI -> Authentication -> Session timeout中配置。要使SID令牌有效，您可以选择

  • 在超时期间定期调用登录方法以重新认证。
  • 或者只启用Bypass authentication for clients in whitelisted IP subnets并为您的IP子网配置，然后您就不再需要调用登录方法。

• 对于4.6.1以上版本，默认凭据不是admin:adminadmin。您必须设置自己的凭据，否则qBittorrent将生成一个随机的凭据。有关更多详细信息，请参阅发行说明

• 此crate处于开发初期。将来可能会出现问题。