Refactor: better API

Author: mathisbot

.github/workflows/rust.yml

@@ -31,7 +31,7 @@ jobs:
         run: cargo test --verbose
 
       - name: Run a basic example
-        run: cargo run --example new_struct
+        run: cargo run --example simple_struct
 
   clippy-fmt:
     runs-on: ubuntu-latest

Cargo.lock

@@ -9,6 +9,7 @@ repository = "https://github.com/mathisbot/homomorph-rust"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+bincode = { version = "2.0.0-rc.3", default-features = false, features = ["alloc", "derive"] }
 getrandom = { version = "0.2.15", default-features = false, features = ["rdrand"] }
 
 [dev-dependencies]

Cargo.toml

@@ -50,9 +50,19 @@ I do not intend to publish the crate on `crates.io`.
 
 ## Bare metal
 
-The crates partially supports `no_std` environments: it uses `Vec` a lot, so it relies on an external `alloc` crate. As each bit ciphered takes up a lot of space, storing ciphered objects on the stack wouldn't be possible (at least on low end machines). This is why the heap is needed here.
+The crates supports `no_std` environments.
 
-You may also need a source of randomness. On bare x86, randomness can still be retrieved using `RDRAND`. On other architectures, such as `aarch64-unknown-none`, you will have to implement `provide_getrandom`, which is a re-export of `getrandom::register_custom_getrandom`, gated behind the `custom_rand` feature.
+As `Vec` is used a lot, the crate relies on an external `alloc` crate.
+As each bit ciphered takes up a lot of space, storing ciphered objects
+on the stack wouldn't be possible (at least on low end machines).
+This is why the heap is needed here.
+
+You may also need a source of randomness.
+On bare x86, randomness can still be retrieved using `RDRAND`.
+On other architectures, such as `aarch64-unknown-none`,
+you will have to implement `provide_getrandom`,
+which is a re-export of `getrandom::register_custom_getrandom`,
+gated behind the `custom_rand` feature.
 
 ## Benchmarks
 
@@ -62,7 +72,7 @@ Parameters used for this benchmark were :
 - `d` = 128
 - `dp` = 128
 - `delta` = 1
-- `tau` = 128.
+- `tau` = 128
 
 | Operation         | Average time     |
 |:-----------------:|:----------------:|

README.md

@@ -38,7 +38,7 @@ function Count-Lines {
 Run-Command "cargo build --lib"
 Run-Command "cargo build --lib --target x86_64-unknown-none"
 Run-Command "cargo test"
-Run-Command "cargo run --example new_struct"
+Run-Command "cargo run --example simple_struct"
 Run-Command "cargo clippy --all-targets --all-features -- -D warnings --no-deps"
 Run-Command "cargo test --release -- --ignored"
 Run-Command "cargo fmt"

check.ps1

@@ -36,7 +36,7 @@ count_lines() {
 run_command "cargo build --lib"
 run_command "cargo build --lib --target x86_64-unknown-none"
 run_command "cargo test"
-run_command "cargo run --example new_struct"
+run_command "cargo run --example simple_struct"
 run_command "cargo clippy --all-targets --all-features -- -D warnings --no-deps"
 run_command "cargo test --release -- --ignored"
 run_command "cargo fmt"

check.sh

@@ -9,40 +9,13 @@ use homomorph::prelude::*;
 
 type Coordinate = u16;
 
-#[derive(Clone, Debug, PartialEq, Eq)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Encode, Decode)]
 struct Vec3 {
     x: Coordinate,
     y: Coordinate,
     z: Coordinate,
 }
 
-// If you don't want to implement `ByteConvertible` for your struct,
-// use repr(C) and derive Copy
-unsafe impl ByteConvertible for Vec3 {
-    fn to_bytes(&self) -> Vec<u8> {
-        let mut bytes = Vec::with_capacity(3 * size_of::<Coordinate>());
-        bytes.extend_from_slice(&self.x.to_le_bytes());
-        bytes.extend_from_slice(&self.y.to_le_bytes());
-        bytes.extend_from_slice(&self.z.to_le_bytes());
-        bytes
-    }
-
-    fn from_bytes(bytes: &[u8]) -> Self {
-        assert!(
-            3 * size_of::<Coordinate>() == bytes.len(),
-            "Invalid size of bytes for conversion: expected {} got {}.",
-            3 * size_of::<Coordinate>(),
-            bytes.len(),
-        );
-
-        let x = Coordinate::from_le_bytes([bytes[0], bytes[1]]);
-        let y = Coordinate::from_le_bytes([bytes[2], bytes[3]]);
-        let z = Coordinate::from_le_bytes([bytes[4], bytes[5]]);
-
-        Self { x, y, z }
-    }
-}
-
 struct Vec3Add;
 
 impl HomomorphicOperation2<Vec3> for Vec3Add {

examples/new_struct.rs renamed to examples/simple_struct.rs

@@ -1,4 +1,4 @@
-use rand::{self, Rng};
+use rand::{thread_rng, Rng};
 use std::time::Instant;
 
 use homomorph::prelude::*;
@@ -7,7 +7,7 @@ use homomorph_impls::numbers::HomomorphicAddition;
 const NUMBER_OF_TESTS: usize = 1_000;
 
 fn main() {
-    let mut rng = rand::thread_rng();
+    let mut rng = thread_rng();
 
     // Create a new context
     let params = Parameters::new(128, 128, 1, 128);
@@ -95,6 +95,13 @@ fn main() {
 
     // Check if the results are correct
     for i in 0..NUMBER_OF_TESTS {
-        assert_eq!(data1[i] + data2[i], decrypted_data_add[i]);
+        assert_eq!(
+            data1[i] + data2[i],
+            decrypted_data_add[i],
+            "Error at index {}: {} != {}",
+            i,
+            data1[i] + data2[i],
+            decrypted_data_add[i]
+        );
     }
 }