Added serde support

Unfortunately serde does not seem to support const-generics yet. I put in an issue at
serde-rs/serde#1272 for this, so we'll see where that goes.

Author: JulianKnodt

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "quick_maths"
 documentation = "https://docs.rs/quick_maths/"
-version = "0.1.1"
+version = "0.1.2"
 authors = ["julianknodt <[email protected]>"]
 edition = "2018"
 readme = "readme.md"
@@ -13,12 +13,14 @@ homepage = "https://github.com/JulianKnodt/quick_maths"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+[features]
+default_f64 = []
+serialization=["serde"]
+
 [dependencies]
 num = "0.2.0"
 cfg-if = "0.1.10"
-
-[features]
-default_f64 = []
+serde = { version = "1.0", features = ["derive"], optional=true}
 
 [profile.release]
 lto = true

Cargo.toml

@@ -40,5 +40,4 @@ allows for easy usage of the library without worrying unless you need to.
 
 #### TODOs
 
-- Add serde support
 - Add benchmarks

readme.md

@@ -12,6 +12,7 @@ use std::{
 
 /// A matrix, where each vector represents a column
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature="serialization", derive(serde::Serialize, serde::Deserialize))]
 pub struct Matrix<T = DefaultFloat, const M: usize, const N: usize>(pub [Vector<T, M>; N])
 where
   [T; M]: LengthAtMost32,

src/mat.rs

@@ -3,6 +3,7 @@ use crate::{
   vec::{Vec3, Vec4},
 };
 
+/// Quats are Vec4's with implicit imaginary first three terms.
 pub type Quat<T> = Vec4<T>;
 
 impl<T: Float> Quat<T> {

src/quat.rs

@@ -9,6 +9,7 @@ use std::{
 };
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature="serialization", derive(serde::Serialize, serde::Deserialize))]
 pub struct Ray<T = f32, V = Vec3<T>> {
   pub pos: V,
   pub dir: V,

src/ray.rs

@@ -5,6 +5,7 @@ use std::{array::LengthAtMost32, ops::Mul};
 /// Transform type which represents an easily invertible operator.
 /// i.e. rotation in 3D, translation, etc.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature="serialization", derive(serde::Serialize, serde::Deserialize))]
 pub struct Transform<T = DefaultFloat, const N: usize>
 where
   [T; N]: LengthAtMost32,

src/transform.rs

@@ -13,6 +13,7 @@ use std::{
 /// Vector over floats and a const-size.
 /// Often used through Vec2, Vec3, and Vec4 instead of the raw struct.
 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd)]
+#[cfg_attr(feature="serialization", derive(serde::Serialize, serde::Deserialize))]
 pub struct Vector<T = DefaultFloat, const N: usize>(pub [T; N])
 where
   [T; N]: LengthAtMost32;