Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fist step to transition away from const generic parameter polution #31

Merged
merged 2 commits into from
Mar 12, 2024
Merged

Fist step to transition away from const generic parameter polution #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20c5f72
Fist step to transition away from const generic parameter polution
nyospe Mar 11, 2024
e79cbf8
Remove unused trait, add some useful trait bounds to
nyospe Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "versioned-binary-serialization"
version = "0.1.0"
version = "0.1.1"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
81 changes: 41 additions & 40 deletions src/bincode_serializer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
use std::io::Write;
use std::{io::Write, marker::PhantomData};

use crate::{binary_serializer::BinarySerializer, version::Version, versioned::Versioned};
use crate::{
binary_serializer::BinarySerializer,
version::{StaticVersionType, Version},
versioned::Versioned,
};
use anyhow::{anyhow, Result};
use serde::{Deserialize, Serialize};

pub struct BincodeSerializer<const VER_MAJOR: u16, const VER_MINOR: u16>;
impl<const VER_MAJOR: u16, const VER_MINOR: u16> BinarySerializer
for BincodeSerializer<VER_MAJOR, VER_MINOR>
{
const MAJOR: u16 = VER_MAJOR;
const MINOR: u16 = VER_MINOR;
pub struct BincodeSerializer<VER: StaticVersionType>(PhantomData<VER>);
impl<VER: StaticVersionType> BinarySerializer for BincodeSerializer<VER> {
const MAJOR: u16 = VER::MAJOR;
const MINOR: u16 = VER::MINOR;
fn serialize_no_version<T: ?Sized>(value: &T) -> Result<Vec<u8>>
where
T: Serialize,
Expand Down Expand Up @@ -38,7 +40,7 @@ impl<const VER_MAJOR: u16, const VER_MINOR: u16> BinarySerializer
T: Deserialize<'a>,
{
let (ver, rest) = Version::deserialize(bytes)?;
if ver.major != VER_MAJOR || ver.minor != VER_MINOR {
if ver.major != VER::MAJOR || ver.minor != VER::MINOR {
return Err(anyhow!(
"Version Mismatch! Expected {}, got {}",
ver,
Expand All @@ -50,16 +52,15 @@ impl<const VER_MAJOR: u16, const VER_MINOR: u16> BinarySerializer
}

// Testing; will use to replace BincodeSerializer after applying `Versioned` to existing serialized types
pub struct VersionChecker<const VER_MAJOR: u16, const VER_MINOR: u16, TYPE: ?Sized + Versioned> {
_phantom: std::marker::PhantomData<TYPE>,
pub struct VersionChecker<VER: StaticVersionType, TYPE: ?Sized + Versioned> {
_phantom_ver: std::marker::PhantomData<VER>,
_phantom_type: std::marker::PhantomData<TYPE>,
}
impl<const VER_MAJOR: u16, const VER_MINOR: u16, TYPE: ?Sized + Versioned>
VersionChecker<VER_MAJOR, VER_MINOR, TYPE>
{
pub const VERSION_MISMATCH: () = if VER_MAJOR < TYPE::MIN_MAJOR
|| VER_MAJOR > TYPE::MAX_MAJOR
|| (VER_MAJOR == TYPE::MIN_MAJOR && VER_MINOR < TYPE::MIN_MINOR)
|| (VER_MAJOR == TYPE::MAX_MAJOR && VER_MINOR > TYPE::MAX_MINOR)
impl<VER: StaticVersionType, TYPE: ?Sized + Versioned> VersionChecker<VER, TYPE> {
pub const VERSION_MISMATCH: () = if VER::MAJOR < TYPE::MIN_MAJOR
|| VER::MAJOR > TYPE::MAX_MAJOR
|| (VER::MAJOR == TYPE::MIN_MAJOR && VER::MINOR < TYPE::MIN_MINOR)
|| (VER::MAJOR == TYPE::MAX_MAJOR && VER::MINOR > TYPE::MAX_MINOR)
{
panic!("unsupported type for version")
};
Expand All @@ -68,6 +69,7 @@ impl<const VER_MAJOR: u16, const VER_MINOR: u16, TYPE: ?Sized + Versioned>
pub trait VersionedBinarySerializer {
const MAJOR: u16;
const MINOR: u16;
type StaticVersion: StaticVersionType;

fn version() -> Version {
Version {
Expand Down Expand Up @@ -95,19 +97,18 @@ pub trait VersionedBinarySerializer {
T: Deserialize<'a> + Versioned;
}

pub struct VersionedBincodeSerializer<const VER_MAJOR: u16, const VER_MINOR: u16>;
impl<const VER_MAJOR: u16, const VER_MINOR: u16> VersionedBinarySerializer
for VersionedBincodeSerializer<VER_MAJOR, VER_MINOR>
{
const MAJOR: u16 = VER_MAJOR;
const MINOR: u16 = VER_MINOR;
pub struct VersionedBincodeSerializer<VER: StaticVersionType>(PhantomData<VER>);
impl<VER: StaticVersionType> VersionedBinarySerializer for VersionedBincodeSerializer<VER> {
const MAJOR: u16 = VER::MAJOR;
const MINOR: u16 = VER::MINOR;
type StaticVersion = VER;

fn serialize_no_version<T: ?Sized>(value: &T) -> Result<Vec<u8>>
where
T: Serialize + Versioned,
{
#[allow(clippy::let_unit_value)]
let _ = VersionChecker::<VER_MAJOR, VER_MINOR, T>::VERSION_MISMATCH;
let _ = VersionChecker::<VER, T>::VERSION_MISMATCH;

Ok(bincode::serialize(value)?)
}
Expand All @@ -117,7 +118,7 @@ impl<const VER_MAJOR: u16, const VER_MINOR: u16> VersionedBinarySerializer
T: Deserialize<'a> + Versioned,
{
#[allow(clippy::let_unit_value)]
let _ = VersionChecker::<VER_MAJOR, VER_MINOR, T>::VERSION_MISMATCH;
let _ = VersionChecker::<VER, T>::VERSION_MISMATCH;

Ok(bincode::deserialize(bytes)?)
}
Expand All @@ -127,7 +128,7 @@ impl<const VER_MAJOR: u16, const VER_MINOR: u16> VersionedBinarySerializer
T: Serialize + Versioned,
{
#[allow(clippy::let_unit_value)]
let _ = VersionChecker::<VER_MAJOR, VER_MINOR, T>::VERSION_MISMATCH;
let _ = VersionChecker::<VER, T>::VERSION_MISMATCH;

let mut vec = Self::version().serialize();
bincode::serialize_into(vec.by_ref(), value)?;
Expand All @@ -139,10 +140,10 @@ impl<const VER_MAJOR: u16, const VER_MINOR: u16> VersionedBinarySerializer
T: Deserialize<'a> + Versioned,
{
#[allow(clippy::let_unit_value)]
let _ = VersionChecker::<VER_MAJOR, VER_MINOR, T>::VERSION_MISMATCH;
let _ = VersionChecker::<VER, T>::VERSION_MISMATCH;

let (ver, rest) = Version::deserialize(bytes)?;
if ver.major != VER_MAJOR || ver.minor != VER_MINOR {
if ver.major != VER::MAJOR || ver.minor != VER::MINOR {
return Err(anyhow!(
"Version Mismatch! Expected {}, got {}",
ver,
Expand All @@ -157,17 +158,19 @@ impl<const VER_MAJOR: u16, const VER_MINOR: u16> VersionedBinarySerializer
mod test {
use serde::{Deserialize, Serialize};

use crate::{binary_serializer::BinarySerializer, version::Version};
use crate::{
binary_serializer::BinarySerializer,
version::{StaticVersion, Version},
versioned::Versioned,
};

use super::{BincodeSerializer, VersionedBinarySerializer, VersionedBincodeSerializer};

mod version_0_1 {
use crate::versioned::Versioned;

use super::*;

pub type Serializer = BincodeSerializer<0u16, 1u16>;
pub type VSerializer = VersionedBincodeSerializer<0u16, 1u16>;
pub type Serializer = BincodeSerializer<StaticVersion<0u16, 1u16>>;
pub type VSerializer = VersionedBincodeSerializer<StaticVersion<0u16, 1u16>>;

#[derive(Serialize, Deserialize)]
pub struct Thing {
Expand All @@ -187,19 +190,17 @@ mod test {
mod version_0_2 {
use super::*;

pub type Serializer = BincodeSerializer<0u16, 2u16>;
pub type VSerializer = VersionedBincodeSerializer<0u16, 2u16>;
pub type Serializer = BincodeSerializer<StaticVersion<0u16, 2u16>>;
pub type VSerializer = VersionedBincodeSerializer<StaticVersion<0u16, 2u16>>;

pub type Thing = version_0_1::Thing;
}

mod version_0_3 {
use crate::versioned::Versioned;

use super::*;

pub type Serializer = BincodeSerializer<0u16, 3u16>;
pub type VSerializer = VersionedBincodeSerializer<0u16, 3u16>;
pub type Serializer = BincodeSerializer<StaticVersion<0u16, 3u16>>;
pub type VSerializer = VersionedBincodeSerializer<StaticVersion<0u16, 3u16>>;

#[derive(Serialize, Deserialize)]
pub struct Thing {
Expand Down
32 changes: 29 additions & 3 deletions src/version.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,31 @@ impl Version {
}
}

pub trait StaticVersionType: Clone + Copy + Debug + private::Sealed {
const MAJOR: u16;
const MINOR: u16;

fn version() -> Version {
Version {
major: Self::MAJOR,
minor: Self::MINOR,
}
}
}

#[derive(Clone, Copy, Display)]
pub struct StaticVersion<const MAJOR: u16, const MINOR: u16>;

impl<const MAJOR: u16, const MINOR: u16> StaticVersion<MAJOR, MINOR> {
pub const MAJOR: u16 = MAJOR;
pub const MINOR: u16 = MINOR;
impl<const MAJOR: u16, const MINOR: u16> StaticVersionType for StaticVersion<MAJOR, MINOR> {
const MAJOR: u16 = MAJOR;
const MINOR: u16 = MINOR;

fn version() -> Version {
Version {
major: Self::MAJOR,
minor: Self::MINOR,
}
}
}

impl<const MAJOR: u16, const MINOR: u16> Debug for StaticVersion<MAJOR, MINOR> {
Expand All @@ -50,3 +69,10 @@ impl<const MAJOR: u16, const MINOR: u16> Debug for StaticVersion<MAJOR, MINOR> {
.finish()
}
}

mod private {
pub trait Sealed {}

// Implement for those same types, but no others.
impl<const MAJOR: u16, const MINOR: u16> Sealed for super::StaticVersion<MAJOR, MINOR> {}
}
Loading