-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move QdrantClientConfig and related structs/traits to config.rs (#100)
- Loading branch information
1 parent
6f96ed2
commit bc0b316
Showing
3 changed files
with
185 additions
and
181 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| use crate::client::QdrantClient; | ||
| use std::time::Duration; | ||
|
|
||
| pub struct QdrantClientConfig { | ||
| pub uri: String, | ||
| pub timeout: Duration, | ||
| pub connect_timeout: Duration, | ||
| pub keep_alive_while_idle: bool, | ||
|
|
||
| /// API key or token to use for authorization | ||
| pub api_key: Option<String>, | ||
| pub compression: Option<CompressionEncoding>, | ||
| } | ||
|
|
||
| impl QdrantClientConfig { | ||
| pub fn from_url(url: &str) -> Self { | ||
| QdrantClientConfig { | ||
| uri: url.to_string(), | ||
| ..Self::default() | ||
| } | ||
| } | ||
|
|
||
| /// Sets the API key or token | ||
| pub fn set_api_key(&mut self, api_key: &str) { | ||
| self.api_key = Some(api_key.to_string()); | ||
| } | ||
|
|
||
| pub fn set_timeout(&mut self, timeout: Duration) { | ||
| self.timeout = timeout; | ||
| } | ||
|
|
||
| pub fn set_connect_timeout(&mut self, connect_timeout: Duration) { | ||
| self.connect_timeout = connect_timeout; | ||
| } | ||
|
|
||
| pub fn set_keep_alive_while_idle(&mut self, keep_alive_while_idle: bool) { | ||
| self.keep_alive_while_idle = keep_alive_while_idle; | ||
| } | ||
|
|
||
| pub fn set_compression(&mut self, compression: Option<CompressionEncoding>) { | ||
| self.compression = compression; | ||
| } | ||
|
|
||
| /// set the API key, builder-like. The API key argument can be any of | ||
| /// `&str`, `String`, `Option<&str>``, `Option<String>` or `Result<String>`.` | ||
| /// | ||
| /// # Examples: | ||
| /// | ||
| /// A typical use case might be getting the key from an env var: | ||
| /// ```rust, no_run | ||
| /// use qdrant_client::prelude::*; | ||
| /// | ||
| /// let client = QdrantClient::from_url("localhost:6334") | ||
| /// .with_api_key(std::env::var("QDRANT_API_KEY")) | ||
| /// .build(); | ||
| /// ``` | ||
| /// Another possibility might be getting it out of some config | ||
| /// ```rust, no_run | ||
| /// use qdrant_client::prelude::*; | ||
| ///# use std::collections::HashMap; | ||
| ///# let config: HashMap<&str, String> = HashMap::new(); | ||
| /// let client = QdrantClientConfig::from_url("localhost:6334") | ||
| /// .with_api_key(config.get("api_key")) | ||
| /// .build(); | ||
| /// ``` | ||
| pub fn with_api_key(mut self, api_key: impl MaybeApiKey) -> Self { | ||
| self.api_key = api_key.maybe_key(); | ||
| self | ||
| } | ||
|
|
||
| /// Configure the service to keep the connection alive while idle | ||
| pub fn keep_alive_while_idle(mut self) -> Self { | ||
| self.keep_alive_while_idle = true; | ||
| self | ||
| } | ||
|
|
||
| /// Set the timeout for this client | ||
| pub fn with_timeout(mut self, timeout: impl AsTimeout) -> Self { | ||
| self.timeout = timeout.timeout(); | ||
| self | ||
| } | ||
|
|
||
| /// Set the connect timeout for this client | ||
| pub fn with_connect_timeout(mut self, timeout: impl AsTimeout) -> Self { | ||
| self.connect_timeout = timeout.timeout(); | ||
| self | ||
| } | ||
|
|
||
| /// Set the compression to use for this client | ||
| pub fn with_compression(mut self, compression: Option<CompressionEncoding>) -> Self { | ||
| self.compression = compression; | ||
| self | ||
| } | ||
|
|
||
| /// Build the QdrantClient | ||
| pub fn build(self) -> anyhow::Result<QdrantClient> { | ||
| QdrantClient::new(Some(self)) | ||
| } | ||
| } | ||
|
|
||
| impl Default for QdrantClientConfig { | ||
| fn default() -> Self { | ||
| Self { | ||
| uri: String::from("http://localhost:6334"), | ||
| timeout: Duration::from_secs(5), | ||
| connect_timeout: Duration::from_secs(5), | ||
| keep_alive_while_idle: true, | ||
| api_key: None, | ||
| compression: None, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// The type of compression to use for requests. | ||
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] | ||
| pub enum CompressionEncoding { | ||
| Gzip, | ||
| } | ||
|
|
||
| impl From<CompressionEncoding> for tonic::codec::CompressionEncoding { | ||
| fn from(encoding: CompressionEncoding) -> Self { | ||
| match encoding { | ||
| CompressionEncoding::Gzip => tonic::codec::CompressionEncoding::Gzip, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| pub trait AsTimeout { | ||
| fn timeout(self) -> Duration; | ||
| } | ||
|
|
||
| impl AsTimeout for Duration { | ||
| fn timeout(self) -> Duration { | ||
| self | ||
| } | ||
| } | ||
|
|
||
| impl AsTimeout for u64 { | ||
| fn timeout(self) -> Duration { | ||
| Duration::from_secs(self) | ||
| } | ||
| } | ||
|
|
||
| /// Helper thread to allow setting an API key from various types | ||
| pub trait MaybeApiKey { | ||
| fn maybe_key(self) -> Option<String>; | ||
| } | ||
|
|
||
| impl MaybeApiKey for &str { | ||
| fn maybe_key(self) -> Option<String> { | ||
| Some(self.to_string()) | ||
| } | ||
| } | ||
|
|
||
| impl MaybeApiKey for String { | ||
| fn maybe_key(self) -> Option<String> { | ||
| Some(self) | ||
| } | ||
| } | ||
|
|
||
| impl MaybeApiKey for Option<String> { | ||
| fn maybe_key(self) -> Option<String> { | ||
| self | ||
| } | ||
| } | ||
|
|
||
| impl MaybeApiKey for Option<&String> { | ||
| fn maybe_key(self) -> Option<String> { | ||
| self.map(ToOwned::to_owned) | ||
| } | ||
| } | ||
|
|
||
| impl MaybeApiKey for Option<&str> { | ||
| fn maybe_key(self) -> Option<String> { | ||
| self.map(ToOwned::to_owned) | ||
| } | ||
| } | ||
|
|
||
| impl<E: Sized> MaybeApiKey for Result<String, E> { | ||
| fn maybe_key(self) -> Option<String> { | ||
| self.ok() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters