Struct DataClient

pub struct DataClient {
    pub http: Client,
    pub api_key: String,
    pub host: String,
}

The data client is used to access an app’s data storage capabilities.

Fields

http: Client

The HTTP client associated with this client.

api_key: String

The app’s API key. You can retrieve this from the web dashboard.

host: String

The origin of the Tetratto server. When creating with DataClient::new, you can provide None to use https://tetratto.com.

Implementations

impl DataClient

pub fn new(host: Option<String>, api_key: String) -> Self

Create a new DataClient.

pub async fn get_app(&self) -> Result<ThirdPartyApp>

Get the current app using the provided API key.

Usage

let client = DataClient::new("https://tetratto.com".to_string(), "...".to_string());
let app = client.get_app().await.expect("failed to get app");

pub async fn check_ip(&self, ip: &str) -> Result<bool>

Check if the given IP is IP banned from the Tetratto host. You will only know if the IP is banned or not, meaning you will not be shown the reason if it is banned.

pub async fn query(&self, query: &SimplifiedQuery) -> Result<AppDataQueryResult>

Query the app’s data.

pub async fn insert(&self, key: String, value: String) -> Result<String>

Insert a key, value pair into the app’s data.

pub async fn update(&self, id: usize, value: String) -> Result<()>

Update a record’s value given its ID and the new value.

pub async fn rename(&self, id: usize, key: String) -> Result<()>

Update a record’s key given its ID and the new key.

pub async fn remove(&self, id: usize) -> Result<()>

Delete a row from the app’s data by its id.

pub async fn remove_query(&self, query: &AppDataQuery) -> Result<()>

Delete row(s) from the app’s data by a query.

Trait Implementations

impl Clone for DataClient

fn clone(&self) -> DataClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.