qbit_rs

Struct Qbit

Source 
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

Source

pub fn builder() -> QbitBuilder

Create a new QbitBuilder to build a Qbit instance.

Source

pub fn new_with_client<U>( endpoint: U, credential: Credential, client: Client, ) -> Self
where U: TryInto<Url>, U::Error: Debug,

Source

pub fn new<U>(endpoint: U, credential: Credential) -> Self
where U: TryInto<Url>, U::Error: Debug,

👎Deprecated: Use QbitBuilder::cookie instead
Source

pub async fn logout(&self) -> Result<(), Error>

Source

pub async fn get_version(&self) -> Result<String, Error>

Source

pub async fn get_webapi_version(&self) -> Result<String, Error>

Source

pub async fn get_build_info(&self) -> Result<BuildInfo, Error>

Source

pub async fn shutdown(&self) -> Result<(), Error>

Source

pub async fn get_preferences(&self) -> Result<Preferences, Error>

Source

pub async fn set_preferences( &self, preferences: impl Borrow<Preferences> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn get_default_save_path(&self) -> Result<PathBuf, Error>

Source

pub async fn get_logs( &self, arg: impl Borrow<GetLogsArg> + Send + Sync, ) -> Result<Vec<Log>, Error>

Source

pub async fn get_peer_logs( &self, last_known_id: impl Into<Option<i64>> + Send + Sync, ) -> Result<Vec<PeerLog>, Error>

Source

pub async fn sync( &self, rid: impl Into<Option<i64>> + Send + Sync, ) -> Result<SyncData, Error>

Source

pub async fn get_torrent_peers( &self, hash: impl AsRef<str> + Send + Sync, rid: impl Into<Option<i64>> + Send + Sync, ) -> Result<PeerSyncData, Error>

Source

pub async fn get_transfer_info(&self) -> Result<TransferInfo, Error>

Source

pub async fn get_speed_limits_mode(&self) -> Result<bool, Error>

Source

pub async fn toggle_speed_limits_mode(&self) -> Result<(), Error>

Source

pub async fn get_download_limit(&self) -> Result<u64, Error>

Source

pub async fn set_download_limit(&self, limit: u64) -> Result<(), Error>

Source

pub async fn get_upload_limit(&self) -> Result<u64, Error>

Source

pub async fn set_upload_limit(&self, limit: u64) -> Result<(), Error>

Source

pub async fn ban_peers( &self, peers: impl Into<Sep<String, '|'>> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn get_torrent_list( &self, arg: GetTorrentListArg, ) -> Result<Vec<Torrent>, Error>

Source

pub async fn export_torrent( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<Bytes, Error>

Source

pub async fn get_torrent_properties( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<TorrentProperty, Error>

Source

pub async fn get_torrent_trackers( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<Vec<Tracker>, Error>

Source

pub async fn get_torrent_web_seeds( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<Vec<WebSeed>, Error>

Source

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>

Source

pub async fn get_torrent_pieces_states( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<Vec<PieceState>, Error>

Source

pub async fn get_torrent_pieces_hashes( &self, hash: impl AsRef<str> + Send + Sync, ) -> Result<Vec<String>, Error>

Source

pub async fn pause_torrents( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn resume_torrents( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn delete_torrents( &self, hashes: impl Into<Hashes> + Send + Sync, delete_files: impl Into<Option<bool>> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn recheck_torrents( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn reannounce_torrents( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn add_torrent( &self, arg: impl Borrow<AddTorrentArg> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn add_trackers( &self, hash: impl AsRef<str> + Send + Sync, urls: impl Into<Sep<String, '\n'>> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn edit_trackers( &self, hash: impl AsRef<str> + Send + Sync, orig_url: Url, new_url: Url, ) -> Result<(), Error>

Source

pub async fn remove_trackers( &self, hash: impl AsRef<str> + Send + Sync, urls: impl Into<Sep<Url, '|'>> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn add_peers( &self, hashes: impl Into<Hashes> + Send + Sync, peers: impl Into<Sep<String, '|'>> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn increase_priority( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn decrease_priority( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn maximal_priority( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn minimal_priority( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn set_file_priority( &self, hash: impl AsRef<str> + Send + Sync, indexes: impl Into<Sep<i64, '|'>> + Send + Sync, priority: Priority, ) -> Result<(), Error>

Source

pub async fn get_torrent_download_limit( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<HashMap<String, u64>, Error>

Source

pub async fn set_torrent_download_limit( &self, hashes: impl Into<Hashes> + Send + Sync, limit: u64, ) -> Result<(), Error>

Source

pub async fn set_torrent_shared_limit( &self, arg: impl Borrow<SetTorrentSharedLimitArg> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn get_torrent_upload_limit( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<HashMap<String, u64>, Error>

Source

pub async fn set_torrent_upload_limit( &self, hashes: impl Into<Hashes> + Send + Sync, limit: u64, ) -> Result<(), Error>

Source

pub async fn set_torrent_location( &self, hashes: impl Into<Hashes> + Send + Sync, location: impl AsRef<Path> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn set_torrent_name<T: AsRef<str> + Send + Sync>( &self, hash: impl AsRef<str> + Send + Sync, name: NonEmptyStr<T>, ) -> Result<(), Error>

Source

pub async fn set_torrent_category( &self, hashes: impl Into<Hashes> + Send + Sync, category: impl AsRef<str> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn get_categories(&self) -> Result<HashMap<String, Category>, Error>

Source

pub async fn add_category<T: AsRef<str> + Send + Sync>( &self, category: NonEmptyStr<T>, save_path: impl AsRef<Path> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn edit_category<T: AsRef<str> + Send + Sync>( &self, category: NonEmptyStr<T>, save_path: impl AsRef<Path> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn remove_categories( &self, categories: impl Into<Sep<String, '\n'>> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn add_torrent_tags( &self, hashes: impl Into<Hashes> + Send + Sync, tags: impl Into<Sep<String, '\n'>> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn remove_torrent_tags( &self, hashes: impl Into<Hashes> + Send + Sync, tags: Option<impl Into<Sep<String, ','>> + Send>, ) -> Result<(), Error>

Source

pub async fn get_all_tags(&self) -> Result<Vec<String>, Error>

Source

pub async fn create_tags( &self, tags: impl Into<Sep<String, ','>> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn delete_tags( &self, tags: impl Into<Sep<String, ','>> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn set_auto_management( &self, hashes: impl Into<Hashes> + Send + Sync, enable: bool, ) -> Result<(), Error>

Source

pub async fn toggle_sequential_download( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn toggle_first_last_piece_priority( &self, hashes: impl Into<Hashes> + Send + Sync, ) -> Result<(), Error>

Source

pub async fn set_force_start( &self, hashes: impl Into<Hashes> + Send + Sync, value: bool, ) -> Result<(), Error>

Source

pub async fn set_super_seeding( &self, hashes: impl Into<Hashes> + Send + Sync, value: bool, ) -> Result<(), Error>

Source

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>

Source

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>

Source

pub async fn add_folder<T: AsRef<str> + Send + Sync>( &self, path: T, ) -> Result<(), Error>

Source

pub async fn add_feed<T: AsRef<str> + Send + Sync>( &self, url: T, path: Option<T>, ) -> Result<(), Error>

Source

pub async fn remove_item<T: AsRef<str> + Send + Sync>( &self, path: T, ) -> Result<(), Error>

Source

pub async fn move_item<T: AsRef<str> + Send + Sync>( &self, item_path: T, dest_path: T, ) -> Result<(), Error>

Source

pub async fn mark_as_read<T: AsRef<str> + Send + Sync>( &self, item_path: T, article_id: Option<T>, ) -> Result<(), Error>

Source

pub async fn refresh_item<T: AsRef<str> + Send + Sync>( &self, item_path: T, ) -> Result<(), Error>

Source

pub async fn rename_rule<T: AsRef<str> + Send + Sync>( &self, rule_name: T, new_rule_name: T, ) -> Result<(), Error>

Source

pub async fn remove_rule<T: AsRef<str> + Send + Sync>( &self, rule_name: T, ) -> Result<(), Error>

Source

pub async fn login(&self, force: bool) -> Result<(), Error>

Log in to qBittorrent. Set force to true to forcefully re-login regardless if cookie is already set.

Trait Implementations§

Source§

impl Clone for Qbit

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where 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) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

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
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

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

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
where Self: Borrow<B>, B: ?Sized,

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
where Self: BorrowMut<B>, B: ?Sized,

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
where Self: AsRef<R>, R: ?Sized,

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
where Self: AsMut<R>, R: ?Sized,

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
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T