Struct TorboxClient

pub struct TorboxClient {
    pub client: Client,
    pub base_url: String,
    /* private fields */
}

Fields

client: Client

Client can be specta skipped because TorboxClient should NEVER be used in any frontend, type is only used to be able to derive the APIs built from it.

base_url: String

Implementations

impl TorboxClient

pub fn new(token: String) -> TorboxClient

pub fn with_base_url(&self, new_base: impl Into<String>) -> TorboxClient

pub fn token(&self) -> &str

pub async fn request_multipart<T>( &self, method: Method, endpoint: &str, form: Form, ) -> Result<T, ApiError>

where T: DeserializeOwned,

pub async fn request<T>( &self, method: Method, endpoint: &str, ) -> Result<T, ApiError>

where T: DeserializeOwned + FromBytes,

pub async fn request_with_json<T, B>( &self, method: Method, endpoint: &str, body: B, ) -> Result<T, ApiError>

where T: DeserializeOwned, B: Serialize,

pub async fn request_with_query<T, Q>( &self, method: Method, endpoint: &str, query: &Q, ) -> Result<T, ApiError>

where T: DeserializeOwned, Q: Serialize,

Trait Implementations

impl Clone for TorboxClient

fn clone(&self) -> TorboxClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl NamedType for TorboxClient

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 Type for TorboxClient

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 Flatten for TorboxClient