Skip to main content

UserApi

Struct UserApi 

Source
pub struct UserApi<'a> { /* private fields */ }
Expand description

Main interface for TorBox User operations

Provides methods for all general API calls including:

  • Retrieving user data
  • Adding referal links
  • Refreshing APIs

Implementations§

Source§

impl<'a> UserApi<'a>

Source

pub fn new(client: &'a TorboxClient) -> Self

Source

pub async fn refresh_api_token( &self, token: String, expires_at: u64, ) -> Result<ApiResponse<String>, ApiError>

Not done

Source

pub async fn get_data( &self, enable_settings: bool, ) -> Result<ApiResponse<UserProfile>, ApiError>

§Overview

Gets a users account data and information.

Source

pub async fn add_referral_code( &self, referral: String, ) -> Result<ApiResponse<()>, ApiError>

Source

pub async fn get_confirmation_code(&self) -> Result<ApiResponse<()>, ApiError>

Source

pub async fn start_device_code_auth( &self, app_name: String, ) -> Result<ApiResponse<DeviceCodeAuth>, ApiError>

Source

pub async fn get_referral_data( &self, ) -> Result<ApiResponse<ReferralData>, ApiError>

Source

pub async fn get_subscription( &self, ) -> Result<ApiResponse<SubscriptionData>, ApiError>

Source

pub async fn get_transactions( &self, ) -> Result<ApiResponse<Vec<TransactionData>>, ApiError>

Source

pub async fn get_search_engines( &self, id: u32, ) -> Result<ApiResponse<Vec<SearchEngineData>>, ApiError>

Source

pub async fn control_search_engines( &self, body: SearchEngineControlBody, ) -> Result<ApiResponse<()>, ApiError>

Source

pub async fn edit_search_engines( &self, body: SearchEngineEditBody, ) -> Result<ApiResponse<SearchEngineData>, ApiError>

Auto Trait Implementations§

§

impl<'a> Freeze for UserApi<'a>

§

impl<'a> !RefUnwindSafe for UserApi<'a>

§

impl<'a> Send for UserApi<'a>

§

impl<'a> Sync for UserApi<'a>

§

impl<'a> Unpin for UserApi<'a>

§

impl<'a> UnsafeUnpin for UserApi<'a>

§

impl<'a> !UnwindSafe for UserApi<'a>

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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,