Skip to content

Commit

Permalink
[wip] refactor towards a design where a minimal set of traits defines…
Browse files Browse the repository at this point in the history 
… data types, and then FieldCopyAccess and FieldView are defined based on those
  • Loading branch information
@smessmer
smessmer committed Feb 8, 2024
1 parent d0482b8 commit 6c5aa10
Show file tree
Hide file tree
Showing 12 changed files with 791 additions and 704 deletions.
5 changes: 5 additions & 0 deletions src/data_types/mod.rs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pub trait DataTypeMetadata {
const SIZE: Option<usize>;
}

pub mod primitive;
95 changes: 30 additions & 65 deletions .../primitive/copy_access/primitive_float.rs → src/data_types/primitive/float.rs
View file
Original file line number Diff line number Diff line change
@@ -1,52 +1,31 @@
use core::convert::Infallible;

use super::{FieldCopyAccess, PrimitiveField};
use super::{PrimitiveRead, PrimitiveWrite};
use crate::data_types::DataTypeMetadata;
use crate::endianness::{EndianKind, Endianness};
use crate::fields::primitive::view::FieldView;
use crate::fields::{Field, StorageIntoFieldView, StorageToFieldView};

macro_rules! float_field {
macro_rules! impl_float {
($type:ty) => {
impl<E: Endianness, const OFFSET_: usize> FieldCopyAccess for PrimitiveField<$type, E, OFFSET_> {
/// See [FieldCopyAccess::ReadError]
type ReadError = Infallible;
/// See [FieldCopyAccess::WriteError]
type WriteError = Infallible;
/// See [FieldCopyAccess::HighLevelType]
type HighLevelType = $type;
impl DataTypeMetadata for $type {
const SIZE: Option<usize> = Some(core::mem::size_of::<$type>());
}

impl PrimitiveRead for $type {
/// Reading floats can't fail
type Error = core::convert::Infallible;

doc_comment::doc_comment! {
concat! {"
Read the float field from a given data region, assuming the defined layout, using the [Field] API.
# Example:
```
use binary_layout::prelude::*;
use core::convert::Infallible;
binary_layout!(my_layout, LittleEndian, {
//... other fields ...
some_float_field: ", stringify!($type), "
//... other fields ...
});
fn func(storage_data: &[u8]) -> ", stringify!($type), " {
let read: ", stringify!($type), " = my_layout::some_float_field::try_read(storage_data).unwrap();
read
}
```
# WARNING
Read the float field from a given storage.
The storage slice size must exactly match the size of the expected float, otherwise this will panic.
# Warning
At it's core, this method uses [", stringify!($type), "::from_bits](https://doc.rust-lang.org/std/primitive.", stringify!($type), ".html#method.from_bits),
which has some weird behavior around signaling and non-signaling `NaN` values. Read the
documentation for [", stringify!($type), "::from_bits](https://doc.rust-lang.org/std/primitive.", stringify!($type), ".html#method.from_bits) which
explains the situation.
"},
#[inline(always)]
fn try_read(storage: &[u8]) -> Result<$type, Infallible> {
let value: [u8; core::mem::size_of::<$type>()] = storage[Self::OFFSET..(Self::OFFSET + core::mem::size_of::<$type>())].try_into().unwrap();
fn try_read<E: Endianness>(storage: &[u8]) -> Result<Self, Self::Error> {
let value: [u8; core::mem::size_of::<$type>()] = storage.try_into().unwrap();
let value = match E::KIND {
EndianKind::Big => <$type>::from_be_bytes(value),
EndianKind::Little => <$type>::from_le_bytes(value),
Expand All @@ -55,54 +34,40 @@ macro_rules! float_field {
Ok(value)
}
}
}

impl PrimitiveWrite for $type {
/// Writing floats can't fail
type Error = core::convert::Infallible;

doc_comment::doc_comment! {
concat! {"
Write the float field to a given data region, assuming the defined layout, using the [Field] API.
# Example:
```
use binary_layout::prelude::*;
binary_layout!(my_layout, LittleEndian, {
//... other fields ...
some_float_field: ", stringify!($type), "
//... other fields ...
});
fn func(storage_data: &mut [u8]) {
my_layout::some_float_field::try_write(storage_data, 10.0).unwrap();
}
```
Write the float field to a given storage.
The storage slice size must exactly match the size of the expected float, otherwise this will panic.
# WARNING
At it's core, this method uses [", stringify!($type), "::to_bits](https://doc.rust-lang.org/std/primitive.", stringify!($type), ".html#method.to_bits),
which has some weird behavior around signaling and non-signaling `NaN` values. Read the
documentation for [", stringify!($type), "::to_bits](https://doc.rust-lang.org/std/primitive.", stringify!($type), ".html#method.to_bits) which
explains the situation.
"},
#[inline(always)]
fn try_write(storage: &mut [u8], value: $type) -> Result<(), Infallible> {
let value_as_bytes = match E::KIND {
EndianKind::Big => value.to_be_bytes(),
EndianKind::Little => value.to_le_bytes(),
EndianKind::Native => value.to_ne_bytes(),
fn try_write<E: Endianness>(self, storage: &mut [u8]) -> Result<(), Self::Error> {
let value = match E::KIND {
EndianKind::Big => self.to_be_bytes(),
EndianKind::Little => self.to_le_bytes(),
EndianKind::Native => self.to_ne_bytes(),
};
storage[Self::OFFSET..(Self::OFFSET + core::mem::size_of::<$type>())]
.copy_from_slice(&value_as_bytes);
storage.copy_from_slice(&value);
Ok(())
}
}
}

impl_field_traits!($type);
};
}

float_field!(f32);
float_field!(f64);
impl_float!(f32);
impl_float!(f64);

#[cfg(test)]
mod tests {
Expand Down
137 changes: 48 additions & 89 deletions ...ds/primitive/copy_access/primitive_int.rs → src/data_types/primitive/int.rs
View file
Original file line number Diff line number Diff line change
@@ -1,102 +1,61 @@
use core::convert::Infallible;

use super::{FieldCopyAccess, PrimitiveField};
use super::{PrimitiveRead, PrimitiveWrite};
use crate::data_types::DataTypeMetadata;
use crate::endianness::{EndianKind, Endianness};
use crate::fields::primitive::view::FieldView;
use crate::fields::{Field, StorageIntoFieldView, StorageToFieldView};

macro_rules! int_field {
macro_rules! impl_int {
($type:ty) => {
impl<E: Endianness, const OFFSET_: usize> FieldCopyAccess for PrimitiveField<$type, E, OFFSET_> {
/// See [FieldCopyAccess::ReadError]
type ReadError = Infallible;
/// See [FieldCopyAccess::WriteError]
type WriteError = Infallible;
/// See [FieldCopyAccess::HighLevelType]
type HighLevelType = $type;

doc_comment::doc_comment! {
concat! {"
Read the integer field from a given data region, assuming the defined layout, using the [Field] API.
# Example:
```
use binary_layout::prelude::*;
binary_layout!(my_layout, LittleEndian, {
//... other fields ...
some_integer_field: ", stringify!($type), "
//... other fields ...
});
fn func(storage_data: &[u8]) -> ",stringify!($type), " {
let read: ", stringify!($type), " = my_layout::some_integer_field::try_read(storage_data).unwrap();
read
}
```
"},
#[inline(always)]
fn try_read(storage: &[u8]) -> Result<$type, Infallible> {
let value: [u8; core::mem::size_of::<$type>()] = storage[Self::OFFSET..(Self::OFFSET + core::mem::size_of::<$type>())].try_into().unwrap();
let value = match E::KIND {
EndianKind::Big => <$type>::from_be_bytes(value),
EndianKind::Little => <$type>::from_le_bytes(value),
EndianKind::Native => <$type>::from_ne_bytes(value)
};
Ok(value)
}
}

doc_comment::doc_comment! {
concat! {"
Write the integer field to a given data region, assuming the defined layout, using the [Field] API.
# Example:
```
use binary_layout::prelude::*;
use core::convert::Infallible;
binary_layout!(my_layout, LittleEndian, {
//... other fields ...
some_integer_field: ", stringify!($type), "
//... other fields ...
});
impl DataTypeMetadata for $type {
const SIZE: Option<usize> = Some(core::mem::size_of::<$type>());
}

fn func(storage_data: &mut [u8]) {
my_layout::some_integer_field::try_write(storage_data, 10).unwrap();
}
```
"},
#[inline(always)]
fn try_write(storage: &mut [u8], value: $type) -> Result<(), Infallible> {
let value_as_bytes = match E::KIND {
EndianKind::Big => value.to_be_bytes(),
EndianKind::Little => value.to_le_bytes(),
EndianKind::Native => value.to_ne_bytes(),
};
storage[Self::OFFSET..(Self::OFFSET + core::mem::size_of::<$type>())]
.copy_from_slice(&value_as_bytes);
Ok(())
}
impl PrimitiveRead for $type {
/// Reading integers can't fail
type Error = core::convert::Infallible;

/// Read the integer field from a given storage.
/// The storage slice size must exactly match the size of the expected integer, otherwise this will panic.
#[inline(always)]
fn try_read<E: Endianness>(storage: &[u8]) -> Result<Self, Self::Error> {
let value: [u8; core::mem::size_of::<$type>()] = storage.try_into().unwrap();
let value = match E::KIND {
EndianKind::Big => <$type>::from_be_bytes(value),
EndianKind::Little => <$type>::from_le_bytes(value),
EndianKind::Native => <$type>::from_ne_bytes(value),
};
Ok(value)
}
}

impl_field_traits!($type);
impl PrimitiveWrite for $type {
/// Writing integers can't fail
type Error = core::convert::Infallible;

/// Write the integer field to a given storage.
/// The storage slice size must exactly match the size of the expected integer, otherwise this will panic.
#[inline(always)]
fn try_write<E: Endianness>(self, storage: &mut [u8]) -> Result<(), Self::Error> {
let value = match E::KIND {
EndianKind::Big => self.to_be_bytes(),
EndianKind::Little => self.to_le_bytes(),
EndianKind::Native => self.to_ne_bytes(),
};
storage.copy_from_slice(&value);
Ok(())
}
}
};
}

int_field!(i8);
int_field!(i16);
int_field!(i32);
int_field!(i64);
int_field!(i128);
int_field!(u8);
int_field!(u16);
int_field!(u32);
int_field!(u64);
int_field!(u128);
impl_int!(u8);
impl_int!(u16);
impl_int!(u32);
impl_int!(u64);
impl_int!(u128);
impl_int!(i8);
impl_int!(i16);
impl_int!(i32);
impl_int!(i64);
impl_int!(i128);

#[cfg(test)]
mod tests {
Expand Down
20 changes: 20 additions & 0 deletions src/data_types/primitive/mod.rs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
use crate::endianness::Endianness;

pub trait PrimitiveRead: Sized {
type Error;

fn try_read<E: Endianness>(storage: &[u8]) -> Result<Self, Self::Error>;
}

pub trait PrimitiveWrite: Sized {
type Error;

fn try_write<E: Endianness>(self, storage: &mut [u8]) -> Result<(), Self::Error>;
}

mod float;
mod int;
mod nonzero_int;
mod unit;

pub use nonzero_int::NonZeroIsZeroError;
Loading

0 comments on commit 6c5aa10

Please sign in to comment.