Skip to main content

DataClient

tetratto_core::sdk

Struct DataClient 

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

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§

Source§

impl DataClient

Source

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

Create a new DataClient.

Examples found in repository?
examples/sdk_db.rs (lines 11-14)
10pub async fn main() {
11    let client = DataClient::new(
12        Some("http://localhost:4118".to_string()),
13        var("APP_API_KEY").unwrap(),
14    );
15
16    println!("data used: {}", client.get_app().await.unwrap().data_used);
17
18    // record insert
19    client
20        .insert("rust_test".to_string(), "Hello, world!".to_string())
21        .await
22        .unwrap();
23    println!("record created");
24    println!("data used: {}", client.get_app().await.unwrap().data_used);
25
26    // testing record query then delete
27    let record = match client
28        .query(&SimplifiedQuery {
29            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
30            mode: AppDataSelectMode::One(0),
31            cache: false,
32        })
33        .await
34        .unwrap()
35    {
36        AppDataQueryResult::One(x) => x,
37        AppDataQueryResult::Many(_) => unreachable!(),
38    };
39
40    println!("{:?}", record);
41
42    client
43        .update(record.id, "Hello, world! 1".to_string())
44        .await
45        .unwrap();
46    println!("record updated");
47    println!("data used: {}", client.get_app().await.unwrap().data_used);
48
49    let record = match client
50        .query(&SimplifiedQuery {
51            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
52            mode: AppDataSelectMode::One(0),
53            cache: false,
54        })
55        .await
56        .unwrap()
57    {
58        AppDataQueryResult::One(x) => x,
59        AppDataQueryResult::Many(_) => unreachable!(),
60    };
61
62    println!("{:?}", record);
63
64    client.remove(record.id).await.unwrap();
65    println!("record deleted");
66    println!("data used: {}", client.get_app().await.unwrap().data_used);
67}
Source

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");
Examples found in repository?
examples/sdk_db.rs (line 16)
10pub async fn main() {
11    let client = DataClient::new(
12        Some("http://localhost:4118".to_string()),
13        var("APP_API_KEY").unwrap(),
14    );
15
16    println!("data used: {}", client.get_app().await.unwrap().data_used);
17
18    // record insert
19    client
20        .insert("rust_test".to_string(), "Hello, world!".to_string())
21        .await
22        .unwrap();
23    println!("record created");
24    println!("data used: {}", client.get_app().await.unwrap().data_used);
25
26    // testing record query then delete
27    let record = match client
28        .query(&SimplifiedQuery {
29            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
30            mode: AppDataSelectMode::One(0),
31            cache: false,
32        })
33        .await
34        .unwrap()
35    {
36        AppDataQueryResult::One(x) => x,
37        AppDataQueryResult::Many(_) => unreachable!(),
38    };
39
40    println!("{:?}", record);
41
42    client
43        .update(record.id, "Hello, world! 1".to_string())
44        .await
45        .unwrap();
46    println!("record updated");
47    println!("data used: {}", client.get_app().await.unwrap().data_used);
48
49    let record = match client
50        .query(&SimplifiedQuery {
51            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
52            mode: AppDataSelectMode::One(0),
53            cache: false,
54        })
55        .await
56        .unwrap()
57    {
58        AppDataQueryResult::One(x) => x,
59        AppDataQueryResult::Many(_) => unreachable!(),
60    };
61
62    println!("{:?}", record);
63
64    client.remove(record.id).await.unwrap();
65    println!("record deleted");
66    println!("data used: {}", client.get_app().await.unwrap().data_used);
67}
Source

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.

Source

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

Query the app’s data.

Examples found in repository?
examples/sdk_db.rs (lines 28-32)
10pub async fn main() {
11    let client = DataClient::new(
12        Some("http://localhost:4118".to_string()),
13        var("APP_API_KEY").unwrap(),
14    );
15
16    println!("data used: {}", client.get_app().await.unwrap().data_used);
17
18    // record insert
19    client
20        .insert("rust_test".to_string(), "Hello, world!".to_string())
21        .await
22        .unwrap();
23    println!("record created");
24    println!("data used: {}", client.get_app().await.unwrap().data_used);
25
26    // testing record query then delete
27    let record = match client
28        .query(&SimplifiedQuery {
29            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
30            mode: AppDataSelectMode::One(0),
31            cache: false,
32        })
33        .await
34        .unwrap()
35    {
36        AppDataQueryResult::One(x) => x,
37        AppDataQueryResult::Many(_) => unreachable!(),
38    };
39
40    println!("{:?}", record);
41
42    client
43        .update(record.id, "Hello, world! 1".to_string())
44        .await
45        .unwrap();
46    println!("record updated");
47    println!("data used: {}", client.get_app().await.unwrap().data_used);
48
49    let record = match client
50        .query(&SimplifiedQuery {
51            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
52            mode: AppDataSelectMode::One(0),
53            cache: false,
54        })
55        .await
56        .unwrap()
57    {
58        AppDataQueryResult::One(x) => x,
59        AppDataQueryResult::Many(_) => unreachable!(),
60    };
61
62    println!("{:?}", record);
63
64    client.remove(record.id).await.unwrap();
65    println!("record deleted");
66    println!("data used: {}", client.get_app().await.unwrap().data_used);
67}
Source

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

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

Examples found in repository?
examples/sdk_db.rs (line 20)
10pub async fn main() {
11    let client = DataClient::new(
12        Some("http://localhost:4118".to_string()),
13        var("APP_API_KEY").unwrap(),
14    );
15
16    println!("data used: {}", client.get_app().await.unwrap().data_used);
17
18    // record insert
19    client
20        .insert("rust_test".to_string(), "Hello, world!".to_string())
21        .await
22        .unwrap();
23    println!("record created");
24    println!("data used: {}", client.get_app().await.unwrap().data_used);
25
26    // testing record query then delete
27    let record = match client
28        .query(&SimplifiedQuery {
29            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
30            mode: AppDataSelectMode::One(0),
31            cache: false,
32        })
33        .await
34        .unwrap()
35    {
36        AppDataQueryResult::One(x) => x,
37        AppDataQueryResult::Many(_) => unreachable!(),
38    };
39
40    println!("{:?}", record);
41
42    client
43        .update(record.id, "Hello, world! 1".to_string())
44        .await
45        .unwrap();
46    println!("record updated");
47    println!("data used: {}", client.get_app().await.unwrap().data_used);
48
49    let record = match client
50        .query(&SimplifiedQuery {
51            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
52            mode: AppDataSelectMode::One(0),
53            cache: false,
54        })
55        .await
56        .unwrap()
57    {
58        AppDataQueryResult::One(x) => x,
59        AppDataQueryResult::Many(_) => unreachable!(),
60    };
61
62    println!("{:?}", record);
63
64    client.remove(record.id).await.unwrap();
65    println!("record deleted");
66    println!("data used: {}", client.get_app().await.unwrap().data_used);
67}
Source

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

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

Examples found in repository?
examples/sdk_db.rs (line 43)
10pub async fn main() {
11    let client = DataClient::new(
12        Some("http://localhost:4118".to_string()),
13        var("APP_API_KEY").unwrap(),
14    );
15
16    println!("data used: {}", client.get_app().await.unwrap().data_used);
17
18    // record insert
19    client
20        .insert("rust_test".to_string(), "Hello, world!".to_string())
21        .await
22        .unwrap();
23    println!("record created");
24    println!("data used: {}", client.get_app().await.unwrap().data_used);
25
26    // testing record query then delete
27    let record = match client
28        .query(&SimplifiedQuery {
29            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
30            mode: AppDataSelectMode::One(0),
31            cache: false,
32        })
33        .await
34        .unwrap()
35    {
36        AppDataQueryResult::One(x) => x,
37        AppDataQueryResult::Many(_) => unreachable!(),
38    };
39
40    println!("{:?}", record);
41
42    client
43        .update(record.id, "Hello, world! 1".to_string())
44        .await
45        .unwrap();
46    println!("record updated");
47    println!("data used: {}", client.get_app().await.unwrap().data_used);
48
49    let record = match client
50        .query(&SimplifiedQuery {
51            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
52            mode: AppDataSelectMode::One(0),
53            cache: false,
54        })
55        .await
56        .unwrap()
57    {
58        AppDataQueryResult::One(x) => x,
59        AppDataQueryResult::Many(_) => unreachable!(),
60    };
61
62    println!("{:?}", record);
63
64    client.remove(record.id).await.unwrap();
65    println!("record deleted");
66    println!("data used: {}", client.get_app().await.unwrap().data_used);
67}
Source

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

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

Source

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

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

Examples found in repository?
examples/sdk_db.rs (line 64)
10pub async fn main() {
11    let client = DataClient::new(
12        Some("http://localhost:4118".to_string()),
13        var("APP_API_KEY").unwrap(),
14    );
15
16    println!("data used: {}", client.get_app().await.unwrap().data_used);
17
18    // record insert
19    client
20        .insert("rust_test".to_string(), "Hello, world!".to_string())
21        .await
22        .unwrap();
23    println!("record created");
24    println!("data used: {}", client.get_app().await.unwrap().data_used);
25
26    // testing record query then delete
27    let record = match client
28        .query(&SimplifiedQuery {
29            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
30            mode: AppDataSelectMode::One(0),
31            cache: false,
32        })
33        .await
34        .unwrap()
35    {
36        AppDataQueryResult::One(x) => x,
37        AppDataQueryResult::Many(_) => unreachable!(),
38    };
39
40    println!("{:?}", record);
41
42    client
43        .update(record.id, "Hello, world! 1".to_string())
44        .await
45        .unwrap();
46    println!("record updated");
47    println!("data used: {}", client.get_app().await.unwrap().data_used);
48
49    let record = match client
50        .query(&SimplifiedQuery {
51            query: AppDataSelectQuery::KeyIs("rust_test".to_string()),
52            mode: AppDataSelectMode::One(0),
53            cache: false,
54        })
55        .await
56        .unwrap()
57    {
58        AppDataQueryResult::One(x) => x,
59        AppDataQueryResult::Many(_) => unreachable!(),
60    };
61
62    println!("{:?}", record);
63
64    client.remove(record.id).await.unwrap();
65    println!("record deleted");
66    println!("data used: {}", client.get_app().await.unwrap().data_used);
67}
Source

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

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

Trait Implementations§

Source§

impl Clone for DataClient

Source§

fn clone(&self) -> DataClient

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DataClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Same for T

Source§

type Output = T

Should always be Self
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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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