qdrant_client/builders/
clear_payload_points_builder.rs

1use crate::grpc_macros::convert_option;
2use crate::qdrant::*;
3
4#[must_use]
5#[derive(Clone)]
6pub struct ClearPayloadPointsBuilder {
7    /// name of the collection
8    pub(crate) collection_name: Option<String>,
9    /// Wait until the changes have been applied?
10    pub(crate) wait: Option<Option<bool>>,
11    /// Affected points
12    points: Option<points_selector::PointsSelectorOneOf>,
13    /// Write ordering guarantees
14    pub(crate) ordering: Option<Option<WriteOrdering>>,
15    /// Option for custom sharding to specify used shard keys
16    pub(crate) shard_key_selector: Option<Option<ShardKeySelector>>,
17    /// Timeout for the request in seconds
18    pub(crate) timeout: Option<Option<u64>>,
19}
20
21impl ClearPayloadPointsBuilder {
22    /// name of the collection
23    pub fn collection_name(self, value: String) -> Self {
24        let mut new = self;
25        new.collection_name = Option::Some(value);
26        new
27    }
28    /// Wait until the changes have been applied?
29    pub fn wait(self, value: bool) -> Self {
30        let mut new = self;
31        new.wait = Option::Some(Option::Some(value));
32        new
33    }
34    /// Affected points
35    pub fn points<VALUE: core::convert::Into<points_selector::PointsSelectorOneOf>>(
36        self,
37        value: VALUE,
38    ) -> Self {
39        let mut new = self;
40        new.points = Option::Some(value.into());
41        new
42    }
43    /// Write ordering guarantees
44    pub fn ordering<VALUE: core::convert::Into<WriteOrdering>>(self, value: VALUE) -> Self {
45        let mut new = self;
46        new.ordering = Option::Some(Option::Some(value.into()));
47        new
48    }
49    /// Option for custom sharding to specify used shard keys
50    pub fn shard_key_selector<VALUE: core::convert::Into<ShardKeySelector>>(
51        self,
52        value: VALUE,
53    ) -> Self {
54        let mut new = self;
55        new.shard_key_selector = Option::Some(Option::Some(value.into()));
56        new
57    }
58    /// Timeout for the request in seconds
59    pub fn timeout(self, value: u64) -> Self {
60        let mut new = self;
61        new.timeout = Option::Some(Option::Some(value));
62        new
63    }
64
65    fn build_inner(self) -> Result<ClearPayloadPoints, ClearPayloadPointsBuilderError> {
66        Ok(ClearPayloadPoints {
67            collection_name: match self.collection_name {
68                Some(value) => value,
69                None => {
70                    return Result::Err(core::convert::Into::into(
71                        ::derive_builder::UninitializedFieldError::from("collection_name"),
72                    ));
73                }
74            },
75            wait: self.wait.unwrap_or_default(),
76            points: { convert_option(&self.points) },
77            ordering: self.ordering.unwrap_or_default(),
78            shard_key_selector: self.shard_key_selector.unwrap_or_default(),
79            timeout: self.timeout.unwrap_or_default(),
80        })
81    }
82    /// Create an empty builder, with all fields set to `None` or `PhantomData`.
83    fn create_empty() -> Self {
84        Self {
85            collection_name: core::default::Default::default(),
86            wait: core::default::Default::default(),
87            points: core::default::Default::default(),
88            ordering: core::default::Default::default(),
89            shard_key_selector: core::default::Default::default(),
90            timeout: core::default::Default::default(),
91        }
92    }
93}
94
95impl From<ClearPayloadPointsBuilder> for ClearPayloadPoints {
96    fn from(value: ClearPayloadPointsBuilder) -> Self {
97        value.build_inner().unwrap_or_else(|_| {
98            panic!(
99                "Failed to convert {0} to {1}",
100                "ClearPayloadPointsBuilder", "ClearPayloadPoints"
101            )
102        })
103    }
104}
105
106impl ClearPayloadPointsBuilder {
107    /// Builds the desired type. Can often be omitted.
108    pub fn build(self) -> ClearPayloadPoints {
109        self.build_inner().unwrap_or_else(|_| {
110            panic!(
111                "Failed to build {0} into {1}",
112                "ClearPayloadPointsBuilder", "ClearPayloadPoints"
113            )
114        })
115    }
116}
117
118impl ClearPayloadPointsBuilder {
119    pub(crate) fn empty() -> Self {
120        Self::create_empty()
121    }
122}
123/// Error type for ClearPayloadPointsBuilder
124#[non_exhaustive]
125#[derive(Debug)]
126pub enum ClearPayloadPointsBuilderError {
127    /// Uninitialized field
128    UninitializedField(&'static str),
129    /// Custom validation error
130    ValidationError(String),
131}
132
133impl std::fmt::Display for ClearPayloadPointsBuilderError {
134    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
135        match self {
136            Self::UninitializedField(field) => {
137                write!(f, "`{field}` must be initialized")
138            }
139            Self::ValidationError(error) => write!(f, "{error}"),
140        }
141    }
142}
143
144impl std::error::Error for ClearPayloadPointsBuilderError {}
145
146impl From<derive_builder::UninitializedFieldError> for ClearPayloadPointsBuilderError {
147    fn from(error: derive_builder::UninitializedFieldError) -> Self {
148        Self::UninitializedField(error.field_name())
149    }
150}
151
152impl From<String> for ClearPayloadPointsBuilderError {
153    fn from(error: String) -> Self {
154        Self::ValidationError(error)
155    }
156}
qdrant_client/builders/clear_payload_points_builder.rs

qdrant_client/builders/
clear_payload_points_builder.rs
