rs-puff 0.1.1

A modern (unofficial) Rust client for Turbopuffer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use reqwest::Method;

use crate::{
    Client, Error, Result,
    params::{MultiQueryParams, QueryParams, WriteParams},
    responses::{
        DeleteAllResponse, HintCacheWarmResponse, MultiQueryResponse, NamespaceMetadata,
        QueryResponse, SchemaResponse, WriteResponse,
    },
};

pub struct Namespace<'a> {
    client: &'a Client,
    name: String,
}

impl<'a> Namespace<'a> {
    pub(crate) fn new(client: &'a Client, name: String) -> Self {
        Self { client, name }
    }

    pub fn name(&self) -> &str {
        &self.name
    }

    fn v1_path(&self, suffix: &str) -> String {
        format!("/v1/namespaces/{}{}", self.name, suffix)
    }

    fn v2_path(&self, suffix: &str) -> String {
        format!("/v2/namespaces/{}{}", self.name, suffix)
    }

    pub async fn write(&self, params: WriteParams) -> Result<WriteResponse> {
        self.client
            .request(Method::POST, &self.v2_path(""), Some(&params))
            .await
    }

    pub async fn query(&self, params: QueryParams) -> Result<QueryResponse> {
        self.client
            .request(Method::POST, &self.v2_path("/query"), Some(&params))
            .await
    }

    pub async fn multi_query(&self, params: MultiQueryParams) -> Result<MultiQueryResponse> {
        self.client
            .request(Method::POST, &self.v2_path("/query"), Some(&params))
            .await
    }

    pub async fn delete_all(&self) -> Result<DeleteAllResponse> {
        self.client
            .request_no_body(Method::DELETE, &self.v2_path(""))
            .await
    }

    pub async fn metadata(&self) -> Result<NamespaceMetadata> {
        self.client
            .request_no_body(Method::GET, &self.v1_path("/metadata"))
            .await
    }

    pub async fn schema(&self) -> Result<SchemaResponse> {
        self.client
            .request_no_body(Method::GET, &self.v1_path("/schema"))
            .await
    }

    pub async fn hint_cache_warm(&self) -> Result<HintCacheWarmResponse> {
        self.client
            .request_no_body(Method::GET, &self.v1_path("/hint_cache_warm"))
            .await
    }

    /// Check if the namespace exists.
    ///
    /// Returns `true` if the namespace exists, `false` if it does not (404 error).
    /// Other errors are propagated.
    pub async fn exists(&self) -> Result<bool> {
        match self.metadata().await {
            Ok(_) => Ok(true),
            Err(Error::Api { status: 404, .. }) => Ok(false),
            Err(e) => Err(e),
        }
    }
}