fix doc tests

Author: RequiemP

src/lib.rs

@@ -153,12 +153,12 @@ pub mod serde_deser;
 // Re-exports
 pub use crate::payload::Payload;
 pub use crate::qdrant_client::error::QdrantError;
-pub use crate::qdrant_client::{Qdrant, QdrantBuilder};
+pub use crate::qdrant_client::{GenericQdrant, Qdrant, QdrantBuilder};
 
 /// Client configuration
 pub mod config {
     pub use crate::qdrant_client::config::{
-        AsOptionApiKey, AsTimeout, CompressionEncoding, QdrantConfig,
+        AsOptionApiKey, AsTimeout, CompressionEncoding, GenericQdrantConfig, QdrantConfig,
     };
 }
 

src/qdrant_client/config.rs

@@ -6,6 +6,8 @@ use crate::auth::{TokenInterceptor, WrappedInterceptor};
 use crate::qdrant_client::GenericQdrant;
 use crate::QdrantError;
 
+pub type QdrantConfig = GenericQdrantConfig<TokenInterceptor>;
+
 struct DefaultConfigValues<I: Send + Sync + 'static + Clone + Interceptor = TokenInterceptor> {
     timeout: Duration,
     connect_timeout: Duration,
@@ -45,7 +47,7 @@ impl<I: Send + Sync + 'static + Clone + Interceptor> Default for DefaultConfigVa
 ///     .build();
 /// ```
 #[derive(Clone)]
-pub struct QdrantConfig<I: Send + Sync + 'static + Clone + Interceptor = TokenInterceptor> {
+pub struct GenericQdrantConfig<I: Send + Sync + 'static + Clone + Interceptor = TokenInterceptor> {
     /// Qdrant server URI to connect to
     pub uri: String,
 
@@ -72,7 +74,7 @@ pub struct QdrantConfig<I: Send + Sync + 'static + Clone + Interceptor = TokenIn
     pub interceptor: WrappedInterceptor<I>,
 }
 
-impl<I: Send + Sync + 'static + Clone + Interceptor> QdrantConfig<I> {
+impl<I: Send + Sync + 'static + Clone + Interceptor> GenericQdrantConfig<I> {
     fn with_defaults(url: &str) -> Self {
         let defaults = DefaultConfigValues::default();
         Self {
@@ -90,7 +92,7 @@ impl<I: Send + Sync + 'static + Clone + Interceptor> QdrantConfig<I> {
     /// Start configuring a Qdrant client with an URL
     ///
     /// ```rust,no_run
-    ///# use qdrant_client::config::QdrantConfig;
+    /// use crate::qdrant_client::config::QdrantConfig;
     /// let client = QdrantConfig::from_url("http://localhost:6334").build();
     /// ```
     ///
@@ -151,7 +153,7 @@ impl<I: Send + Sync + 'static + Clone + Interceptor> QdrantConfig<I> {
     /// Set the interceptor to use for this client
     ///
     /// ```no_run
-    /// use qdrant_client::GenericQdrant;
+    /// use crate::qdrant_client::GenericQdrant;
     /// use tonic::service::Interceptor;
     /// use tonic::{Request, Status};
     ///
@@ -164,7 +166,7 @@ impl<I: Send + Sync + 'static + Clone + Interceptor> QdrantConfig<I> {
     /// }
     ///
     ///# async fn connect() -> Result<(), qdrant_client::QdrantError> {
-    /// let client = GenericQdrant<CustomInterceptor>::from_url("http://localhost:6334")
+    /// let client = GenericQdrant::<CustomInterceptor>::from_url("http://localhost:6334")
     /// .interceptor(CustomInterceptor)
     /// .build()?;
     ///# Ok(())
@@ -227,7 +229,7 @@ impl<I: Send + Sync + 'static + Clone + Interceptor> QdrantConfig<I> {
     }
 }
 
-impl QdrantConfig<TokenInterceptor> {
+impl GenericQdrantConfig<TokenInterceptor> {
     /// Set an optional API key
     ///
     /// This method is only available when using the default TokenInterceptor.
@@ -259,7 +261,7 @@ impl QdrantConfig<TokenInterceptor> {
 /// Default Qdrant client configuration.
 ///
 /// Connects to `http://localhost:6334` without an API key.
-impl Default for QdrantConfig<TokenInterceptor> {
+impl Default for GenericQdrantConfig<TokenInterceptor> {
     fn default() -> Self {
         Self::with_defaults("http://localhost:6334")
     }

src/qdrant_client/mod.rs

@@ -23,6 +23,7 @@ use tonic::Status;
 
 use crate::auth::{TokenInterceptor, WrappedInterceptor};
 use crate::channel_pool::ChannelPool;
+use crate::config::GenericQdrantConfig;
 use crate::qdrant::{qdrant_client, HealthCheckReply, HealthCheckRequest};
 use crate::qdrant_client::config::QdrantConfig;
 use crate::qdrant_client::version_check::is_compatible;
@@ -87,7 +88,7 @@ pub type Qdrant = GenericQdrant<TokenInterceptor>;
 #[derive(Clone)]
 pub struct GenericQdrant<I: Send + Sync + 'static + Clone + Interceptor> {
     /// Client configuration
-    pub config: QdrantConfig<I>,
+    pub config: GenericQdrantConfig<I>,
 
     /// Internal connection pool
     channel: Arc<ChannelPool>,
@@ -99,8 +100,8 @@ pub struct GenericQdrant<I: Send + Sync + 'static + Clone + Interceptor> {
 impl<I: Send + Sync + 'static + Clone + Interceptor> GenericQdrant<I> {
     /// Create a new Qdrant client.
     ///
-    /// Constructs the client and connects based on the given [`QdrantConfig`](config::QdrantConfig).
-    pub fn new(config: QdrantConfig<I>) -> QdrantResult<Self> {
+    /// Constructs the client and connects based on the given [`GenericQdrantConfig`](config::GenericQdrantConfig).
+    pub fn new(config: GenericQdrantConfig<I>) -> QdrantResult<Self> {
         if config.check_compatibility {
             // create a temporary client to check compatibility
             let channel = ChannelPool::new(
@@ -176,8 +177,8 @@ impl<I: Send + Sync + 'static + Clone + Interceptor> GenericQdrant<I> {
     /// ```
     ///
     /// See more ways to set up the client [here](Self#set-up).
-    pub fn from_url(url: &str) -> QdrantConfig<I> {
-        QdrantConfig::<I>::from_url(url)
+    pub fn from_url(url: &str) -> GenericQdrantConfig<I> {
+        GenericQdrantConfig::<I>::from_url(url)
     }
 
     /// Wraps a channel with the configured interceptor