Struct GeneralApi 

pub struct GeneralApi<'a> { /* private fields */ }

Main interface for TorBox general operations

Provides methods for all general API calls including:

• Up status
• Changelogs in both RSS and JSON
• Test files

Implementations

impl<'a> GeneralApi<'a>

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

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

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

pub async fn get_changelog_rss_feed(&self) -> Result<String, ApiError>

pub async fn get_changelog_json_versions( &self, ) -> Result<ApiResponse<Vec<ChangelogJsonVersion>>, ApiError>

pub async fn get_speedtest_files( &self, test_length: Option<FileLength>, region: Option<String>, ) -> Result<ApiResponse<Vec<SpeedtestFile>>, ApiError>

Trait Implementations

impl<'a> NamedType for GeneralApi<'a>

fn sid() -> SpectaID

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

this is equivalent to Type::inline but returns a NamedDataType instead.

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

this is equivalent to [Type::definition] but returns a NamedDataType instead.

impl<'a> Type for GeneralApi<'a>

fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType

Returns the definition of a type using the provided generics.

fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.

impl<'a> Flatten for GeneralApi<'a>