pub struct Qbit { /* private fields */ }
Expand description
Main entry point of the library. It provides a high-level API to interact with qBittorrent WebUI API.
Implementations§
source§impl Qbit
impl Qbit
sourcepub fn builder() -> QbitBuilder
pub fn builder() -> QbitBuilder
Create a new QbitBuilder
to build a Qbit
instance.
pub fn new_with_client<U>( endpoint: U, credential: Credential, client: Client, ) -> Self
pub fn new<U>(endpoint: U, credential: Credential) -> Self
👎Deprecated: Use
QbitBuilder::cookie
insteadpub async fn logout(&self) -> Result<(), Error>
pub async fn get_version(&self) -> Result<String, Error>
pub async fn get_webapi_version(&self) -> Result<String, Error>
pub async fn get_build_info(&self) -> Result<BuildInfo, Error>
pub async fn shutdown(&self) -> Result<(), Error>
pub async fn get_preferences(&self) -> Result<Preferences, Error>
pub async fn set_preferences( &self, preferences: impl Borrow<Preferences> + Send + Sync, ) -> Result<(), Error>
pub async fn get_default_save_path(&self) -> Result<PathBuf, Error>
pub async fn get_logs( &self, arg: impl Borrow<GetLogsArg> + Send + Sync, ) -> Result<Vec<Log>, Error>
pub async fn get_peer_logs( &self, last_known_id: impl Into<Option<i64>> + Send + Sync, ) -> Result<Vec<PeerLog>, Error>
pub async fn sync( &self, rid: impl Into<Option<i64>> + Send + Sync, ) -> Result<SyncData, Error>
pub async fn get_torrent_peers( &self, hash: impl AsRef<str> + Send + Sync, rid: impl Into<Option<i64>> + Send + Sync, ) -> Result<PeerSyncData, Error>
pub async fn get_transfer_info(&self) -> Result<TransferInfo, Error>
pub async fn get_speed_limits_mode(&self) -> Result<bool, Error>
pub async fn toggle_speed_limits_mode(&self) -> Result<(), Error>
pub async fn get_download_limit(&self) -> Result<u64, Error>
pub async fn set_download_limit(&self, limit: u64) -> Result<(), Error>
pub async fn get_upload_limit(&self) -> Result<u64, Error>
pub async fn set_upload_limit(&self, limit: u64) -> Result<(), Error>
pub async fn ban_peers( &self, peers: impl Into<Sep<String, '|'>> + Send + Sync, ) -> Result<(), Error>
pub async fn get_torrent_list( &self, arg: GetTorrentListArg, ) -> Result<Vec<Torrent>, Error>
pub async fn export_torrent( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<Bytes, Error>
pub async fn get_torrent_properties( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<TorrentProperty, Error>
pub async fn get_torrent_trackers( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<Vec<Tracker>, Error>
pub async fn get_torrent_web_seeds( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<Vec<WebSeed>, Error>
pub async fn get_torrent_contents( &self, hash: impl AsRef<str> + Send + Sync, indexes: impl Into<Option<Sep<String, '|'>>> + Send + Sync, ) -> Result<Vec<TorrentContent>, Error>
pub async fn get_torrent_pieces_states( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<Vec<PieceState>, Error>
pub async fn get_torrent_pieces_hashes( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<Vec<String>, Error>
pub async fn pause_torrents( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>
pub async fn resume_torrents( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>
pub async fn delete_torrents( &self, hashes: impl Into<Hashes> + Send + Sync, delete_files: impl Into<Option<bool>> + Send + Sync, ) -> Result<(), Error>
pub async fn recheck_torrents( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>
pub async fn reannounce_torrents( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>
pub async fn add_torrent( &self, arg: impl Borrow<AddTorrentArg> + Send + Sync, ) -> Result<(), Error>
pub async fn add_trackers( &self, hash: impl AsRef<str> + Send + Sync, urls: impl Into<Sep<String, '\n'>> + Send + Sync, ) -> Result<(), Error>
pub async fn edit_trackers( &self, hash: impl AsRef<str> + Send + Sync, orig_url: Url, new_url: Url, ) -> Result<(), Error>
pub async fn remove_trackers( &self, hash: impl AsRef<str> + Send + Sync, urls: impl Into<Sep<Url, '|'>> + Send + Sync, ) -> Result<(), Error>
pub async fn add_peers( &self, hashes: impl Into<Hashes> + Send + Sync, peers: impl Into<Sep<String, '|'>> + Send + Sync, ) -> Result<(), Error>
pub async fn increase_priority( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>
pub async fn decrease_priority( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>
pub async fn maximal_priority( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>
pub async fn minimal_priority( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>
pub async fn set_file_priority( &self, hash: impl AsRef<str> + Send + Sync, indexes: impl Into<Sep<i64, '|'>> + Send + Sync, priority: Priority, ) -> Result<(), Error>
pub async fn get_torrent_download_limit( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<HashMap<String, u64>, Error>
pub async fn set_torrent_download_limit( &self, hashes: impl Into<Hashes> + Send + Sync, limit: u64, ) -> Result<(), Error>
pub async fn get_torrent_upload_limit( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<HashMap<String, u64>, Error>
pub async fn set_torrent_upload_limit( &self, hashes: impl Into<Hashes> + Send + Sync, limit: u64, ) -> Result<(), Error>
pub async fn set_torrent_location( &self, hashes: impl Into<Hashes> + Send + Sync, location: impl AsRef<Path> + Send + Sync, ) -> Result<(), Error>
pub async fn set_torrent_name<T: AsRef<str> + Send + Sync>( &self, hash: impl AsRef<str> + Send + Sync, name: NonEmptyStr<T>, ) -> Result<(), Error>
pub async fn set_torrent_category( &self, hashes: impl Into<Hashes> + Send + Sync, category: impl AsRef<str> + Send + Sync, ) -> Result<(), Error>
pub async fn get_categories(&self) -> Result<HashMap<String, Category>, Error>
pub async fn add_category<T: AsRef<str> + Send + Sync>( &self, category: NonEmptyStr<T>, save_path: impl AsRef<Path> + Send + Sync, ) -> Result<(), Error>
pub async fn edit_category<T: AsRef<str> + Send + Sync>( &self, category: NonEmptyStr<T>, save_path: impl AsRef<Path> + Send + Sync, ) -> Result<(), Error>
pub async fn remove_categories( &self, categories: impl Into<Sep<String, '\n'>> + Send + Sync, ) -> Result<(), Error>
pub async fn set_auto_management( &self, hashes: impl Into<Hashes> + Send + Sync, enable: bool, ) -> Result<(), Error>
pub async fn toggle_sequential_download( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>
pub async fn toggle_first_last_piece_priority( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>
pub async fn set_force_start( &self, hashes: impl Into<Hashes> + Send + Sync, value: bool, ) -> Result<(), Error>
pub async fn set_super_seeding( &self, hashes: impl Into<Hashes> + Send + Sync, value: bool, ) -> Result<(), Error>
pub async fn rename_file( &self, hash: impl AsRef<str> + Send + Sync, old_path: impl AsRef<Path> + Send + Sync, new_path: impl AsRef<Path> + Send + Sync, ) -> Result<(), Error>
pub async fn rename_folder( &self, hash: impl AsRef<str> + Send + Sync, old_path: impl AsRef<Path> + Send + Sync, new_path: impl AsRef<Path> + Send + Sync, ) -> Result<(), Error>
pub async fn add_folder<T: AsRef<str> + Send + Sync>( &self, path: T, ) -> Result<(), Error>
pub async fn add_feed<T: AsRef<str> + Send + Sync>( &self, url: T, path: Option<T>, ) -> Result<(), Error>
pub async fn remove_item<T: AsRef<str> + Send + Sync>( &self, path: T, ) -> Result<(), Error>
pub async fn move_item<T: AsRef<str> + Send + Sync>( &self, item_path: T, dest_path: T, ) -> Result<(), Error>
pub async fn mark_as_read<T: AsRef<str> + Send + Sync>( &self, item_path: T, article_id: Option<T>, ) -> Result<(), Error>
pub async fn refresh_item<T: AsRef<str> + Send + Sync>( &self, item_path: T, ) -> Result<(), Error>
pub async fn rename_rule<T: AsRef<str> + Send + Sync>( &self, rule_name: T, new_rule_name: T, ) -> Result<(), Error>
pub async fn remove_rule<T: AsRef<str> + Send + Sync>( &self, rule_name: T, ) -> Result<(), Error>
Auto Trait Implementations§
impl !Freeze for Qbit
impl !RefUnwindSafe for Qbit
impl Send for Qbit
impl Sync for Qbit
impl Unpin for Qbit
impl !UnwindSafe for Qbit
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.