DocumentPartial

Author: RoDmitry

openapi-generator-template/reqwest/api.mustache

@@ -8,15 +8,20 @@ use super::{Error, configuration, ContentType};
 {{#operations}}
 {{#operation}}
 {{#vendorExtensions.x-group-parameters}}
-{{#allParams}}
-{{#-first}}
+{{^allParams}}
+/*
+{{/allParams}}
 /// struct for passing parameters to the method [`{{operationId}}`]
 #[derive(Clone, Debug)]
-pub struct {{{operationIdCamelCase}}}Params {
-{{/-first}}
+pub struct {{{operationIdCamelCase}}}Params{{{vendorExtensions.x-rust-params-generic-parameter}}} {
+{{#allParams}}
     {{#description}}
     /// {{{.}}}
     {{/description}}
+    {{#vendorExtensions.x-rust-type}}
+    pub {{{paramName}}}: {{{.}}},
+    {{/vendorExtensions.x-rust-type}}
+    {{^vendorExtensions.x-rust-type}}
     pub {{{paramName}}}: {{!
     ### Option Start
     }}{{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{!
@@ -27,14 +32,14 @@ pub struct {{{operationIdCamelCase}}}Params {
     ### Models and primative types
     }}{{^isString}}{{^isUuid}}{{^isPrimitiveType}}{{^isContainer}}models::{{/isContainer}}{{/isPrimitiveType}}{{{dataType}}}{{/isUuid}}{{/isString}}{{!
     ### Option End
-    }}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}}{{!
-    ### Comma for next arguement
-    }}{{^-last}},{{/-last}}
-{{#-last}}
+    }}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}},
+    {{/vendorExtensions.x-rust-type}}
+{{/allParams}}
 }
-
-{{/-last}}
+{{^allParams}}
+*/
 {{/allParams}}
+
 {{/vendorExtensions.x-group-parameters}}
 {{/operation}}
 {{/operations}}
@@ -92,14 +97,19 @@ pub enum {{{operationIdCamelCase}}}Error {
 /// {{{.}}}
 {{/notes}}
 {{#vendorExtensions.x-group-parameters}}
-pub {{#supportAsync}}async {{/supportAsync}}fn {{{operationId}}}{{{vendorExtensions.x-rust-generic-parameter}}}(configuration: &configuration::Configuration{{#allParams}}{{#-first}}, {{!
-### Params
-}}params: &{{{operationIdCamelCase}}}Params{{/-first}}{{/allParams}}{{!
+pub {{#supportAsync}}async {{/supportAsync}}fn {{{operationId}}}{{{vendorExtensions.x-rust-generic-parameter}}}(configuration: &configuration::Configuration
+{{^allParams}}
+/*
+{{/allParams}}
+, params: &{{{operationIdCamelCase}}}Params{{{vendorExtensions.x-rust-params-generic-parameter}}}
+{{^allParams}}
+*/
+{{/allParams}}{{!
 ### Function return type
 }}) -> Result<{{#vendorExtensions.x-rust-return-type}}{{{.}}}{{/vendorExtensions.x-rust-return-type}}{{^vendorExtensions.x-rust-return-type}}{{#isResponseFile}}{{#supportAsync}}reqwest::Response{{/supportAsync}}{{^supportAsync}}reqwest::blocking::Response{{/supportAsync}}{{/isResponseFile}}{{^isResponseFile}}{{#supportMultipleResponses}}ResponseContent<{{{operationIdCamelCase}}}Success>{{/supportMultipleResponses}}{{^supportMultipleResponses}}{{^returnType}}(){{/returnType}}{{{returnType}}}{{/supportMultipleResponses}}{{/isResponseFile}}{{/vendorExtensions.x-rust-return-type}}, Error<{{{operationIdCamelCase}}}Error>> {
 {{/vendorExtensions.x-group-parameters}}
 {{^vendorExtensions.x-group-parameters}}
-pub {{#supportAsync}}async {{/supportAsync}}fn {{{operationId}}}{{{vendorExtensions.x-rust-generic-parameter}}}(configuration: &configuration::Configuration, {{#allParams}}{{{paramName}}}: {{!
+pub {{#supportAsync}}async {{/supportAsync}}fn {{{operationId}}}{{{vendorExtensions.x-rust-generic-parameter}}}{{{vendorExtensions.x-rust-params-generic-parameter}}}(configuration: &configuration::Configuration, {{#allParams}}{{{paramName}}}: {{!
 ### Option Start
 }}{{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{!
 ### &str and Vec<&str>

preprocessed_openapi.yml

@@ -348,6 +348,9 @@ paths:
               description: Can be any key-value pair
               x-go-type: interface{}
         required: true
+        x-rust-type: B
+      x-rust-params-generic-parameter: <B>
+      x-rust-generic-parameter: '<B: Serialize>'
     delete:
       tags:
       - documents
@@ -1253,6 +1256,9 @@ paths:
               description: Can be any key-value pair
               x-go-type: interface{}
         required: true
+        x-rust-type: B
+      x-rust-params-generic-parameter: <B>
+      x-rust-generic-parameter: '<B: Serialize>'
       responses:
         '200':
           description: The document referenced by the ID was updated

typesense/src/client/collection/document.rs

@@ -4,7 +4,7 @@
 //! via a parent `Collection` struct, for example:
 //! `client.collection::<Book>().document("123")`
 
-use crate::{Client, Error, execute_wrapper};
+use crate::{Client, Error, execute_wrapper, traits};
 use serde::{Serialize, de::DeserializeOwned};
 use typesense_codegen::apis::documents_api;
 
@@ -55,6 +55,28 @@ where
         serde_json::from_value(result_value).map_err(Error::from)
     }
 
+    /// Deletes this individual document from the collection.
+    /// The deleted document is returned.
+    ///
+    /// # Returns
+    /// A `Result` containing the deleted document deserialized into `D`.
+    pub async fn delete(&self) -> Result<D, Error<documents_api::DeleteDocumentError>> {
+        let params = documents_api::DeleteDocumentParams {
+            collection_name: self.collection_name.to_owned(),
+            document_id: self.document_id.to_owned(),
+        };
+
+        let result_value = execute_wrapper!(self, documents_api::delete_document, params)?;
+
+        // Deserialize the raw JSON value of the deleted document into T.
+        serde_json::from_value(result_value).map_err(Error::from)
+    }
+}
+
+impl<'c, 'n, D> Document<'c, 'n, D>
+where
+    D: traits::Document,
+{
     /// Updates this individual document. The update can be partial.
     /// The updated full document is returned.
     ///
@@ -68,9 +90,9 @@ where
     /// # Example
     /// ```no_run
     /// # use serde::{Serialize, Deserialize};
-    /// # use typesense::{Client, models};
+    /// # use typesense::{Client, Typesense, models};
     /// # use reqwest::Url;
-    /// # #[derive(Serialize, Deserialize)]
+    /// # #[derive(Typesense, Serialize, Deserialize)]
     /// # struct Book { id: String, title: String, pages: i32 }
     /// #
     /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
@@ -79,7 +101,7 @@ where
     /// #    .api_key("xyz")
     /// #    .build()
     /// #    .unwrap();
-    /// let book_update = serde_json::json!({ "pages": 654 });
+    /// let book_update = BookPartial { pages: Some(654), ..Default::default() };
     ///
     /// // Simple update
     /// let updated_book = client.collection_named::<Book>("books").document("123")
@@ -97,15 +119,15 @@ where
     /// # Ok(())
     /// # }
     /// ```
-    pub async fn update<U: Serialize>(
+    pub async fn update(
         &self,
-        partial_document: U,
+        partial_document: &D::Partial,
         params: Option<crate::models::DocumentIndexParameters>,
     ) -> Result<D, Error<documents_api::UpdateDocumentError>> {
         let params = documents_api::UpdateDocumentParams {
             collection_name: self.collection_name.to_owned(),
             document_id: self.document_id.to_owned(),
-            body: serde_json::to_value(partial_document)?,
+            body: partial_document,
             dirty_values: params.and_then(|d| d.dirty_values),
         };
 
@@ -114,21 +136,4 @@ where
         // Deserialize the raw JSON value of the updated document into T.
         serde_json::from_value(result_value).map_err(Error::from)
     }
-
-    /// Deletes this individual document from the collection.
-    /// The deleted document is returned.
-    ///
-    /// # Returns
-    /// A `Result` containing the deleted document deserialized into `D`.
-    pub async fn delete(&self) -> Result<D, Error<documents_api::DeleteDocumentError>> {
-        let params = documents_api::DeleteDocumentParams {
-            collection_name: self.collection_name.to_owned(),
-            document_id: self.document_id.to_owned(),
-        };
-
-        let result_value = execute_wrapper!(self, documents_api::delete_document, params)?;
-
-        // Deserialize the raw JSON value of the deleted document into T.
-        serde_json::from_value(result_value).map_err(Error::from)
-    }
 }

typesense/src/client/collection/documents.rs

@@ -7,6 +7,7 @@
 use crate::{
     Client, Error, execute_wrapper,
     models::{DocumentIndexParameters, SearchResult},
+    traits,
 };
 use serde::{Serialize, de::DeserializeOwned};
 use typesense_codegen::{
@@ -63,43 +64,6 @@ where
         execute_wrapper!(self, documents_api::index_document, params)
     }
 
-    /// Creates a new document in the collection.
-    ///
-    /// Fails if a document with the same ID already exists. If the document has an `id` field
-    /// of type `string`, it will be used as the document's ID. Otherwise, Typesense will
-    /// auto-generate an ID. The newly indexed document is returned.
-    ///
-    /// # Arguments
-    /// * `document` - A serializable struct or a `serde_json::Value` representing the document to create.
-    /// * `params` - Optional parameters like `dirty_values`.
-    pub async fn create<U: Serialize>(
-        &self,
-        document: U,
-        params: Option<DocumentIndexParameters>,
-    ) -> Result<D, Error<documents_api::IndexDocumentError>> {
-        let doc_value = serde_json::to_value(document)?;
-        let result_value = self.index(doc_value, "create", params).await?;
-        serde_json::from_value(result_value).map_err(Error::from)
-    }
-
-    /// Creates a new document or updates an existing one if an ID match is found.
-    ///
-    /// This method requires the full document to be sent. For partial updates, use
-    /// `collection().document("...").update()`. The indexed document is returned.
-    ///
-    /// # Arguments
-    /// * `document` - A serializable struct or a `serde_json::Value` representing the document to upsert.
-    /// * `params` - Optional parameters like `dirty_values`.
-    pub async fn upsert<U: Serialize>(
-        &self,
-        document: U,
-        params: Option<DocumentIndexParameters>,
-    ) -> Result<D, Error<documents_api::IndexDocumentError>> {
-        let doc_value = serde_json::to_value(document)?;
-        let result_value = self.index(doc_value, "upsert", params).await?;
-        serde_json::from_value(result_value).map_err(Error::from)
-    }
-
     // --- Bulk Operation Methods ---
 
     /// Imports a batch of documents in JSONL format.
@@ -164,25 +128,6 @@ where
         execute_wrapper!(self, documents_api::delete_documents, params)
     }
 
-    /// Updates a batch of documents matching a specific filter condition.
-    ///
-    /// # Arguments
-    /// * `document` - A serializable struct or a `serde_json::Value` containing the fields to update.
-    /// * `params` - A `UpdateDocumentsParameters` describing the conditions for updating documents.
-    pub async fn update<U: Serialize>(
-        &self,
-        document: U,
-        params: UpdateDocumentsParameters,
-    ) -> Result<raw_models::UpdateDocuments200Response, Error<documents_api::UpdateDocumentsError>>
-    {
-        let params = documents_api::UpdateDocumentsParams {
-            collection_name: self.collection_name.to_owned(),
-            filter_by: params.filter_by,
-            body: serde_json::to_value(document)?,
-        };
-        execute_wrapper!(self, documents_api::update_documents, params)
-    }
-
     /// Searches for documents in the collection that match the given criteria.
     /// The search results will have their `document` field deserialized into type `D`.
     ///
@@ -271,3 +216,64 @@ where
         execute_wrapper!(self, documents_api::search_collection, search_params)
     }
 }
+
+impl<'c, 'n, D> Documents<'c, 'n, D>
+where
+    D: traits::Document,
+{
+    /// Creates a new document in the collection.
+    ///
+    /// Fails if a document with the same ID already exists. If the document has an `id` field
+    /// of type `string`, it will be used as the document's ID. Otherwise, Typesense will
+    /// auto-generate an ID. The newly indexed document is returned.
+    ///
+    /// # Arguments
+    /// * `document` - A document struct to create.
+    /// * `params` - Optional parameters like `dirty_values`.
+    pub async fn create(
+        &self,
+        document: &D,
+        params: Option<DocumentIndexParameters>,
+    ) -> Result<D, Error<documents_api::IndexDocumentError>> {
+        let doc_value = serde_json::to_value(document)?;
+        let result_value = self.index(doc_value, "create", params).await?;
+        serde_json::from_value(result_value).map_err(Error::from)
+    }
+
+    /// Creates a new document or updates an existing one if an ID match is found.
+    ///
+    /// This method requires the full document to be sent. For partial updates, use
+    /// `collection().document("...").update()`. The indexed document is returned.
+    ///
+    /// # Arguments
+    /// * `document` - A document struct to upsert.
+    /// * `params` - Optional parameters like `dirty_values`.
+    pub async fn upsert(
+        &self,
+        document: &D,
+        params: Option<DocumentIndexParameters>,
+    ) -> Result<D, Error<documents_api::IndexDocumentError>> {
+        let doc_value = serde_json::to_value(document)?;
+        let result_value = self.index(doc_value, "upsert", params).await?;
+        serde_json::from_value(result_value).map_err(Error::from)
+    }
+
+    /// Updates a batch of documents matching a specific filter condition.
+    ///
+    /// # Arguments
+    /// * `document` - A struct containing the fields to update.
+    /// * `params` - A `UpdateDocumentsParameters` describing the conditions for updating documents.
+    pub async fn update(
+        &self,
+        document: &D::Partial,
+        params: UpdateDocumentsParameters,
+    ) -> Result<raw_models::UpdateDocuments200Response, Error<documents_api::UpdateDocumentsError>>
+    {
+        let params = documents_api::UpdateDocumentsParams {
+            collection_name: self.collection_name.to_owned(),
+            filter_by: params.filter_by,
+            body: document,
+        };
+        execute_wrapper!(self, documents_api::update_documents, params)
+    }
+}

typesense/src/traits/document.rs

@@ -6,11 +6,16 @@
 use crate::models::CollectionSchema;
 use serde::{Serialize, de::DeserializeOwned};
 
-/// Trait that should implement every struct that wants to be represented as a Typesense
+/// Trait for partial structs
+pub trait DocumentPartial: Serialize {}
+
+/// Trait that every struct should implement that wants to be represented as a Typesense
 /// Document
 pub trait Document: DeserializeOwned + Serialize {
     /// Collection name
     const COLLECTION_NAME: &'static str;
+    /// A struct for partial updates
+    type Partial: DocumentPartial;
 
     /// Collection schema associated with the document.
     fn collection_schema() -> CollectionSchema;

typesense/src/traits/mod.rs

@@ -4,6 +4,6 @@ mod document;
 mod field_type;
 mod multi_search_ext;
 
-pub use document::Document;
+pub use document::*;
 pub use field_type::*;
 pub use multi_search_ext::MultiSearchResultExt;