From 32f3fccf178ac85a6d8842b03f06b3e4662e880c Mon Sep 17 00:00:00 2001
From: sha512sum <linuxnyasha@tutanota.com>
Date: Tue, 27 Aug 2024 18:52:39 +0000
Subject: [PATCH] Add comments for field set helpers

---
 src/lib/utils.cpp | 44 ++++++++++++++++++++++++++++++++++++++------
 1 file changed, 38 insertions(+), 6 deletions(-)

diff --git a/src/lib/utils.cpp b/src/lib/utils.cpp
index a7cde5d..2681150 100644
--- a/src/lib/utils.cpp
+++ b/src/lib/utils.cpp
@@ -6,12 +6,28 @@ import utempl;
 
 namespace larra::xmpp::utils {
 
-template <typename T, typename... Fs>
-struct FieldDescription {
-  utempl::Tuple<Fs...> tuple;
+template <typename T, typename R>
+constexpr auto GetType(R(T::* ptr)) -> R;
 
-  template <typename R>
-  constexpr auto GetType(R(T::* ptr)) -> R;
+// Fields description
+// struct SomeStruct {
+//   std::string field1;
+//   std::string field2;
+//   static constexpr /* FieldsDescription */ auto kUtils = CreateFieldsDescription(&SomeStruct::field1, &SomeStruct::field2);
+//
+//   template <typename Self>
+//   constexpr auto Field1(this Self&& self, std::string field1) -> SomeStruct {
+//     return kUtils.With<0>(std::forward<Self>(self), std::move(field1)); // Return new object with field1 value from field1 and with
+//     // field2 value from self.field2
+//   }
+//   template <typename Self>
+//   constexpr auto Field2(this Self&& self, std::string field2) -> SomeStruct {
+//     return kUtils.With(&SomeStruct::field2, std::forward<Self>(self), std::move(field2)); // With field2
+//   }
+// };
+template <typename T, typename... Fs>
+struct FieldsDescription {
+  utempl::Tuple<Fs...> tuple;
 
   template <std::size_t I, typename Self, typename Value>
   constexpr auto With(Self&& self, Value&& value) const
@@ -52,7 +68,7 @@ struct FieldDescription {
 };
 
 template <typename T, typename... Fs>
-consteval auto CreateFieldsDescriptionHelper(Fs&&... fs) -> FieldDescription<T, std::decay_t<Fs>...> {
+consteval auto CreateFieldsDescriptionHelper(Fs&&... fs) -> FieldsDescription<T, std::decay_t<Fs>...> {
   return {.tuple = {std::forward<Fs>(fs)...}};
 };
 
@@ -63,6 +79,22 @@ consteval auto CreateFieldsDescription(Rs(T::*... ptr)) {
   } | utempl::kSeq<sizeof...(Rs)>;
 };
 
+// Field set helper
+// struct SomeStruct {
+//   std::string field1;
+//   std::string field2;
+//
+//  template <typename Self>
+//  auto Field1(this Self&& self, std::string field1) -> SomeStruct {
+//    return FieldSetHelper::With<0>(std::forward<Self>(self), std::move(field1)); // Return new object with field1 value from field1
+//     // and with field2 value from self.field2
+//  }
+//  template <typename Self>
+//  auto Field2(this Self&& self, std::string field2) -> SomeStruct {
+//    return FieldSetHelper::With<"field2">(std::forward<Self>(self), std::move(field2)); // With field2
+//  }
+// };
+
 export struct FieldSetHelper {
   template <std::size_t I, typename Self, typename Value>
   static constexpr auto With(Self&& self, Value&& value)