Redesign API (#3)

* redesign library * clean code * fix pylint * add methods for scalars * fix examples * fix pylint * fix example * fix clang build * fix casting * cpp-17 * fix clang build * print types if they missmatch * use real type * force type * update CHANGELOG
panda-official · Jul 28, 2023 · 5e8885a · 5e8885a
1 parent 4a21e9e
commit 5e8885a
Show file tree

Hide file tree

Showing 18 changed files with 744 additions and 671 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ dist
 python/CMakeFiles
 python/*.cmake
 python/src/drift_bytes.egg-info
+*.so
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Use `set_` prefix for setters, [PR-2](https://github.com/panda-official/DriftBytes/pull/2)
+- Redesign API, [PR-3](https://github.com/panda-official/DriftBytes/pull/3)
 
 ## 0.1.0 - 2023-07-20
 

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -49,6 +49,7 @@ set_target_properties(
     ${TARGET_NAME}
     PROPERTIES CXX_STANDARD 17 CXX_STANDARD_REQUIRED ON CXX_EXTENSIONS OFF
 )
+target_compile_features(${TARGET_NAME} INTERFACE cxx_std_17)
 
 target_include_directories(
     ${TARGET_NAME}

diff --git a/README.md b/README.md
@@ -32,16 +32,22 @@ which is suitable for non-floating point data.
 
 #include <iostream>
 
-using drift_bytes::Bytes;
+using drift_bytes::InputBuffer;
+using drift_bytes::OutputBuffer;
+using drift_bytes::Variant;
 
 int main() {
-    uint8_t val{42};
-    auto bytes = Bytes();
-    bytes.set_scalar(val);
-    auto new_val = bytes.set_scalar<uint8_t>();
+  Variant some_value{42};
 
-    std::cout << new_val << std::endl;
+  OutputBuffer buffer;
+  buffer.push_back(some_value);
+
+  InputBuffer input(buffer.str());
+  Variant new_val = input.pop();
+
+  std::cout << new_val << std::endl;
 }
+
 ```
 
 ## Bulding

diff --git a/conan/test_package/CMakeLists.txt b/conan/test_package/CMakeLists.txt
@@ -4,5 +4,5 @@ project(WaveletBufferTest CXX)
 find_package(drift_bytes CONFIG REQUIRED)
 
 add_executable(example src/example.cc)
-target_compile_features(example PUBLIC cxx_std_20)
+target_compile_features(example PUBLIC cxx_std_17)
 target_link_libraries(example drift_bytes::drift_bytes)
diff --git a/conan/test_package/src/example.cc b/conan/test_package/src/example.cc
@@ -2,13 +2,18 @@
 
 #include <iostream>
 
-using drift_bytes::Bytes;
+using drift_bytes::InputBuffer;
+using drift_bytes::OutputBuffer;
+using drift_bytes::Variant;
 
 int main() {
-  uint8_t val{42};
-  auto bytes = Bytes();
-  bytes.set_scalar(val);
-  auto new_val = bytes.scalar<uint8_t>();
+  Variant some_value{42};
+
+  OutputBuffer buffer;
+  buffer.push_back(some_value);
+
+  InputBuffer input(buffer.str());
+  Variant new_val = input.pop();
 
   std::cout << new_val << std::endl;
 }