Skip to main content

qdrant_client/builders/
keyword_index_params_builder.rs

1use crate::qdrant::*;
2
3#[must_use]
4#[derive(Clone)]
5pub struct KeywordIndexParamsBuilder {
6    /// If true - used for tenant optimization.
7    pub(crate) is_tenant: Option<Option<bool>>,
8    /// If true - store index on disk.
9    pub(crate) on_disk: Option<Option<bool>>,
10    /// If true - enable HNSW index for this field.
11    pub(crate) enable_hnsw: Option<Option<bool>>,
12}
13
14impl Default for KeywordIndexParamsBuilder {
15    fn default() -> Self {
16        Self::create_empty()
17    }
18}
19
20impl KeywordIndexParamsBuilder {
21    /// If true - used for tenant optimization.
22    pub fn is_tenant(self, value: bool) -> Self {
23        let mut new = self;
24        new.is_tenant = Option::Some(Option::Some(value));
25        new
26    }
27    /// If true - store index on disk.
28    pub fn on_disk(self, value: bool) -> Self {
29        let mut new = self;
30        new.on_disk = Option::Some(Option::Some(value));
31        new
32    }
33    /// If true - enable HNSW index for this field.
34    pub fn enable_hnsw(self, value: bool) -> Self {
35        let mut new = self;
36        new.enable_hnsw = Option::Some(Option::Some(value));
37        new
38    }
39
40    fn build_inner(self) -> Result<KeywordIndexParams, std::convert::Infallible> {
41        Ok(KeywordIndexParams {
42            is_tenant: self.is_tenant.unwrap_or_default(),
43            on_disk: self.on_disk.unwrap_or_default(),
44            enable_hnsw: self.enable_hnsw.unwrap_or_default(),
45        })
46    }
47    /// Create an empty builder, with all fields set to `None` or `PhantomData`.
48    fn create_empty() -> Self {
49        Self {
50            is_tenant: core::default::Default::default(),
51            on_disk: core::default::Default::default(),
52            enable_hnsw: core::default::Default::default(),
53        }
54    }
55}
56
57impl From<KeywordIndexParamsBuilder> for KeywordIndexParams {
58    fn from(value: KeywordIndexParamsBuilder) -> Self {
59        value.build_inner().unwrap_or_else(|_| {
60            panic!(
61                "Failed to convert {0} to {1}",
62                "KeywordIndexParamsBuilder", "KeywordIndexParams"
63            )
64        })
65    }
66}
67
68impl KeywordIndexParamsBuilder {
69    /// Builds the desired type. Can often be omitted.
70    pub fn build(self) -> KeywordIndexParams {
71        self.build_inner().unwrap_or_else(|_| {
72            panic!(
73                "Failed to build {0} into {1}",
74                "KeywordIndexParamsBuilder", "KeywordIndexParams"
75            )
76        })
77    }
78}