#[cfg(not(feature = "std"))]
use alloc::{string::String, vec::Vec};
use crate::chunk_cache::ChunkCache;
use crate::chunked_read::{
read_chunked_data, read_chunked_data_cached, read_chunked_data_cached_from_source,
read_chunked_data_from_source,
};
use crate::convert::{TryToUsize, slice_range};
use crate::data_layout::DataLayout;
use crate::dataspace::Dataspace;
use crate::datatype::{Datatype, DatatypeByteOrder};
use crate::error::FormatError;
use crate::filter_pipeline::FilterPipeline;
use crate::source::FileSource;
#[cfg(test)]
pub fn read_raw_data(
file_data: &[u8],
layout: &DataLayout,
dataspace: &Dataspace,
datatype: &Datatype,
) -> Result<Vec<u8>, FormatError> {
read_raw_data_full(file_data, layout, dataspace, datatype, None, 8, 8)
}
pub fn read_raw_data_full(
file_data: &[u8],
layout: &DataLayout,
dataspace: &Dataspace,
datatype: &Datatype,
pipeline: Option<&FilterPipeline>,
offset_size: u8,
length_size: u8,
) -> Result<Vec<u8>, FormatError> {
let num_elements = dataspace.num_elements().to_usize()?;
let elem_size = datatype.type_size() as usize;
let expected_size = num_elements
.checked_mul(elem_size)
.ok_or(FormatError::OffsetOverflow {
offset: num_elements as u64,
length: elem_size as u64,
})?;
if num_elements == 0 {
return Ok(Vec::new());
}
match layout {
DataLayout::Compact { data } => {
if data.len() != expected_size {
return Err(FormatError::DataSizeMismatch {
expected: expected_size,
actual: data.len(),
});
}
Ok(data.clone())
}
DataLayout::Contiguous { address, size } => {
let addr = address.ok_or(FormatError::NoDataAllocated)?;
let r = slice_range(addr, *size)?;
let sz = r.end - r.start;
if sz != expected_size {
return Err(FormatError::DataSizeMismatch {
expected: expected_size,
actual: sz,
});
}
if r.end > file_data.len() {
return Err(FormatError::UnexpectedEof {
expected: r.end,
available: file_data.len(),
});
}
Ok(file_data[r].to_vec())
}
DataLayout::Chunked { .. } => read_chunked_data(
file_data,
layout,
dataspace,
datatype,
pipeline,
offset_size,
length_size,
),
DataLayout::Virtual { .. } => Err(FormatError::UnsupportedVirtualLayout),
}
}
pub fn read_raw_data_cached(
file_data: &[u8],
layout: &DataLayout,
dataspace: &Dataspace,
datatype: &Datatype,
pipeline: Option<&FilterPipeline>,
offset_size: u8,
length_size: u8,
cache: &ChunkCache,
) -> Result<Vec<u8>, FormatError> {
match layout {
DataLayout::Chunked { .. } => read_chunked_data_cached(
file_data,
layout,
dataspace,
datatype,
pipeline,
offset_size,
length_size,
cache,
),
_ => read_raw_data_full(
file_data,
layout,
dataspace,
datatype,
pipeline,
offset_size,
length_size,
),
}
}
pub fn read_raw_data_full_from_source<S: FileSource + ?Sized>(
source: &S,
layout: &DataLayout,
dataspace: &Dataspace,
datatype: &Datatype,
pipeline: Option<&FilterPipeline>,
offset_size: u8,
length_size: u8,
) -> Result<Vec<u8>, FormatError> {
let num_elements = dataspace.num_elements().to_usize()?;
let elem_size = datatype.type_size() as usize;
let expected_size = num_elements
.checked_mul(elem_size)
.ok_or(FormatError::OffsetOverflow {
offset: num_elements as u64,
length: elem_size as u64,
})?;
if num_elements == 0 {
return Ok(Vec::new());
}
match layout {
DataLayout::Compact { data } => {
if data.len() != expected_size {
return Err(FormatError::DataSizeMismatch {
expected: expected_size,
actual: data.len(),
});
}
Ok(data.clone())
}
DataLayout::Contiguous { address, size } => {
let addr = address.ok_or(FormatError::NoDataAllocated)?;
let sz = (*size).to_usize()?;
if sz != expected_size {
return Err(FormatError::DataSizeMismatch {
expected: expected_size,
actual: sz,
});
}
source.read_exact_at(addr, sz)
}
DataLayout::Chunked { .. } => read_chunked_data_from_source(
source,
layout,
dataspace,
datatype,
pipeline,
offset_size,
length_size,
),
DataLayout::Virtual { .. } => Err(FormatError::UnsupportedVirtualLayout),
}
}
#[allow(clippy::too_many_arguments)]
pub fn read_raw_data_cached_from_source<S: FileSource + ?Sized>(
source: &S,
layout: &DataLayout,
dataspace: &Dataspace,
datatype: &Datatype,
pipeline: Option<&FilterPipeline>,
offset_size: u8,
length_size: u8,
cache: &ChunkCache,
) -> Result<Vec<u8>, FormatError> {
match layout {
DataLayout::Chunked { .. } => read_chunked_data_cached_from_source(
source,
layout,
dataspace,
datatype,
pipeline,
offset_size,
length_size,
cache,
),
_ => read_raw_data_full_from_source(
source,
layout,
dataspace,
datatype,
pipeline,
offset_size,
length_size,
),
}
}
fn datatype_name(dt: &Datatype) -> &'static str {
match dt {
Datatype::FixedPoint { .. } => "FixedPoint",
Datatype::FloatingPoint { .. } => "FloatingPoint",
Datatype::String { .. } => "String",
Datatype::Time { .. } => "Time",
Datatype::BitField { .. } => "BitField",
Datatype::Opaque { .. } => "Opaque",
Datatype::Compound { .. } => "Compound",
Datatype::Reference { .. } => "Reference",
Datatype::Enumeration { .. } => "Enumeration",
Datatype::VariableLength { .. } => "VariableLength",
Datatype::Array { .. } => "Array",
}
}
fn ensure_numeric(dt: &Datatype, expected: &'static str) -> Result<(), FormatError> {
match dt {
Datatype::FixedPoint { .. } | Datatype::FloatingPoint { .. } => Ok(()),
_ => Err(FormatError::TypeMismatch {
expected,
actual: datatype_name(dt),
}),
}
}
fn get_byte_order(dt: &Datatype) -> DatatypeByteOrder {
match dt {
Datatype::FixedPoint { byte_order, .. } => byte_order.clone(),
Datatype::FloatingPoint { byte_order, .. } => byte_order.clone(),
_ => DatatypeByteOrder::LittleEndian,
}
}
fn get_size(dt: &Datatype) -> usize {
dt.type_size() as usize
}
fn is_standard_layout(
elem_size: usize,
order: &DatatypeByteOrder,
bit_offset: u16,
bit_precision: u16,
) -> bool {
matches!(
order,
DatatypeByteOrder::LittleEndian | DatatypeByteOrder::BigEndian
) && bit_offset == 0
&& bit_precision as usize == elem_size * 8
&& matches!(elem_size, 1 | 2 | 4 | 8)
}
macro_rules! bulk_decode {
($raw:expr, $count:expr, $order:expr, $store:ty, $out:ty) => {{
const W: usize = core::mem::size_of::<$store>();
let mut result: Vec<$out> = Vec::with_capacity($count);
match $order {
DatatypeByteOrder::BigEndian => {
for c in $raw.chunks_exact(W) {
let a: [u8; W] = c.try_into().unwrap();
#[allow(
clippy::cast_possible_truncation,
clippy::cast_possible_wrap,
clippy::unnecessary_cast
)]
result.push(<$store>::from_be_bytes(a) as $out);
}
}
_ => {
for c in $raw.chunks_exact(W) {
let a: [u8; W] = c.try_into().unwrap();
#[allow(
clippy::cast_possible_truncation,
clippy::cast_possible_wrap,
clippy::unnecessary_cast
)]
result.push(<$store>::from_le_bytes(a) as $out);
}
}
}
result
}};
}
pub fn read_as_f64(raw: &[u8], datatype: &Datatype) -> Result<Vec<f64>, FormatError> {
ensure_numeric(datatype, "FloatingPoint or FixedPoint")?;
let elem_size = get_size(datatype);
if elem_size == 0 || !raw.len().is_multiple_of(elem_size) {
return Err(FormatError::DataSizeMismatch {
expected: 0,
actual: raw.len(),
});
}
let count = raw.len() / elem_size;
let order = get_byte_order(datatype);
let (bit_offset, bit_precision) = int_bits(datatype);
if is_standard_layout(elem_size, &order, bit_offset, bit_precision) {
match datatype {
Datatype::FloatingPoint { size: 4, .. } => {
return Ok(bulk_decode!(raw, count, order, f32, f64));
}
Datatype::FloatingPoint { size: 8, .. } => {
return Ok(bulk_decode!(raw, count, order, f64, f64));
}
Datatype::FixedPoint { signed: true, .. } => {
return Ok(match elem_size {
1 => bulk_decode!(raw, count, order, i8, f64),
2 => bulk_decode!(raw, count, order, i16, f64),
4 => bulk_decode!(raw, count, order, i32, f64),
8 => bulk_decode!(raw, count, order, i64, f64),
_ => unreachable!(),
});
}
Datatype::FixedPoint { signed: false, .. } => {
return Ok(match elem_size {
1 => bulk_decode!(raw, count, order, u8, f64),
2 => bulk_decode!(raw, count, order, u16, f64),
4 => bulk_decode!(raw, count, order, u32, f64),
8 => bulk_decode!(raw, count, order, u64, f64),
_ => unreachable!(),
});
}
_ => {}
}
}
let mut result = Vec::with_capacity(count);
for i in 0..count {
let chunk = &raw[i * elem_size..(i + 1) * elem_size];
let val = convert_to_f64(chunk, datatype, &order)?;
result.push(val);
}
Ok(result)
}
fn convert_to_f64(
bytes: &[u8],
dt: &Datatype,
order: &DatatypeByteOrder,
) -> Result<f64, FormatError> {
match dt {
Datatype::FloatingPoint { size, .. } => match size {
4 => {
let v = read_f32_bytes(bytes, order);
Ok(v as f64)
}
8 => Ok(read_f64_bytes(bytes, order)),
_ => Err(FormatError::DataSizeMismatch {
expected: 8,
actual: *size as usize,
}),
},
Datatype::FixedPoint {
size,
signed,
bit_offset,
bit_precision,
..
} => {
if *signed {
let v = read_signed_int(bytes, *size as usize, order, *bit_offset, *bit_precision);
Ok(v as f64)
} else {
let v =
read_unsigned_int(bytes, *size as usize, order, *bit_offset, *bit_precision);
Ok(v as f64)
}
}
_ => Err(FormatError::TypeMismatch {
expected: "numeric",
actual: datatype_name(dt),
}),
}
}
pub fn read_as_i64(raw: &[u8], datatype: &Datatype) -> Result<Vec<i64>, FormatError> {
ensure_numeric(datatype, "FixedPoint (signed)")?;
let elem_size = get_size(datatype);
if elem_size == 0 || !raw.len().is_multiple_of(elem_size) {
return Err(FormatError::DataSizeMismatch {
expected: 0,
actual: raw.len(),
});
}
let count = raw.len() / elem_size;
let order = get_byte_order(datatype);
let (bit_offset, bit_precision) = int_bits(datatype);
if is_standard_layout(elem_size, &order, bit_offset, bit_precision) {
return Ok(match elem_size {
1 => bulk_decode!(raw, count, order, i8, i64),
2 => bulk_decode!(raw, count, order, i16, i64),
4 => bulk_decode!(raw, count, order, i32, i64),
8 => bulk_decode!(raw, count, order, i64, i64),
_ => unreachable!(),
});
}
let mut result = Vec::with_capacity(count);
for i in 0..count {
let chunk = &raw[i * elem_size..(i + 1) * elem_size];
let v = read_signed_int(chunk, elem_size, &order, bit_offset, bit_precision);
result.push(v);
}
Ok(result)
}
pub fn read_as_u64(raw: &[u8], datatype: &Datatype) -> Result<Vec<u64>, FormatError> {
ensure_numeric(datatype, "FixedPoint (unsigned)")?;
let elem_size = get_size(datatype);
if elem_size == 0 || !raw.len().is_multiple_of(elem_size) {
return Err(FormatError::DataSizeMismatch {
expected: 0,
actual: raw.len(),
});
}
let count = raw.len() / elem_size;
let order = get_byte_order(datatype);
let (bit_offset, bit_precision) = int_bits(datatype);
if is_standard_layout(elem_size, &order, bit_offset, bit_precision) {
return Ok(match elem_size {
1 => bulk_decode!(raw, count, order, u8, u64),
2 => bulk_decode!(raw, count, order, u16, u64),
4 => bulk_decode!(raw, count, order, u32, u64),
8 => bulk_decode!(raw, count, order, u64, u64),
_ => unreachable!(),
});
}
let mut result = Vec::with_capacity(count);
for i in 0..count {
let chunk = &raw[i * elem_size..(i + 1) * elem_size];
let v = read_unsigned_int(chunk, elem_size, &order, bit_offset, bit_precision);
result.push(v);
}
Ok(result)
}
pub fn read_as_f32(raw: &[u8], datatype: &Datatype) -> Result<Vec<f32>, FormatError> {
ensure_numeric(datatype, "FloatingPoint")?;
let elem_size = get_size(datatype);
if elem_size == 0 || !raw.len().is_multiple_of(elem_size) {
return Err(FormatError::DataSizeMismatch {
expected: 0,
actual: raw.len(),
});
}
let count = raw.len() / elem_size;
let order = get_byte_order(datatype);
let (bit_offset, bit_precision) = int_bits(datatype);
if is_standard_layout(elem_size, &order, bit_offset, bit_precision) {
match datatype {
Datatype::FloatingPoint { size: 4, .. } => {
return Ok(bulk_decode!(raw, count, order, f32, f32));
}
Datatype::FloatingPoint { size: 8, .. } => {
return Ok(bulk_decode!(raw, count, order, f64, f32));
}
Datatype::FixedPoint { signed: true, .. } => {
return Ok(match elem_size {
1 => bulk_decode!(raw, count, order, i8, f32),
2 => bulk_decode!(raw, count, order, i16, f32),
4 => bulk_decode!(raw, count, order, i32, f32),
8 => bulk_decode!(raw, count, order, i64, f32),
_ => unreachable!(),
});
}
Datatype::FixedPoint { signed: false, .. } => {
return Ok(match elem_size {
1 => bulk_decode!(raw, count, order, u8, f32),
2 => bulk_decode!(raw, count, order, u16, f32),
4 => bulk_decode!(raw, count, order, u32, f32),
8 => bulk_decode!(raw, count, order, u64, f32),
_ => unreachable!(),
});
}
_ => {}
}
}
let mut result = Vec::with_capacity(count);
for i in 0..count {
let chunk = &raw[i * elem_size..(i + 1) * elem_size];
match datatype {
Datatype::FloatingPoint { size: 4, .. } => {
result.push(read_f32_bytes(chunk, &order));
}
Datatype::FloatingPoint { size: 8, .. } => {
#[expect(
clippy::cast_possible_truncation,
reason = "read_as_f32 narrows stored f64 values to the requested f32"
)]
result.push(read_f64_bytes(chunk, &order) as f32);
}
Datatype::FixedPoint {
signed: true,
size,
bit_offset,
bit_precision,
..
} => {
result.push(read_signed_int(
chunk,
*size as usize,
&order,
*bit_offset,
*bit_precision,
) as f32);
}
Datatype::FixedPoint {
signed: false,
size,
bit_offset,
bit_precision,
..
} => {
result.push(read_unsigned_int(
chunk,
*size as usize,
&order,
*bit_offset,
*bit_precision,
) as f32);
}
_ => {
return Err(FormatError::TypeMismatch {
expected: "numeric",
actual: datatype_name(datatype),
});
}
}
}
Ok(result)
}
pub fn read_as_i32(raw: &[u8], datatype: &Datatype) -> Result<Vec<i32>, FormatError> {
ensure_numeric(datatype, "FixedPoint")?;
let elem_size = get_size(datatype);
if elem_size == 0 || !raw.len().is_multiple_of(elem_size) {
return Err(FormatError::DataSizeMismatch {
expected: 0,
actual: raw.len(),
});
}
let count = raw.len() / elem_size;
let order = get_byte_order(datatype);
let (bit_offset, bit_precision) = int_bits(datatype);
if is_standard_layout(elem_size, &order, bit_offset, bit_precision) {
return Ok(match elem_size {
1 => bulk_decode!(raw, count, order, i8, i32),
2 => bulk_decode!(raw, count, order, i16, i32),
4 => bulk_decode!(raw, count, order, i32, i32),
8 => bulk_decode!(raw, count, order, i64, i32),
_ => unreachable!(),
});
}
let mut result = Vec::with_capacity(count);
for i in 0..count {
let chunk = &raw[i * elem_size..(i + 1) * elem_size];
let v = read_signed_int(chunk, elem_size, &order, bit_offset, bit_precision);
#[expect(
clippy::cast_possible_truncation,
reason = "read_as_i32 narrows each stored signed value to the requested i32"
)]
result.push(v as i32);
}
Ok(result)
}
pub fn read_as_i16(raw: &[u8], datatype: &Datatype) -> Result<Vec<i16>, FormatError> {
ensure_numeric(datatype, "FixedPoint")?;
let elem_size = get_size(datatype);
if elem_size == 0 || !raw.len().is_multiple_of(elem_size) {
return Err(FormatError::DataSizeMismatch {
expected: 0,
actual: raw.len(),
});
}
let count = raw.len() / elem_size;
let order = get_byte_order(datatype);
let (bit_offset, bit_precision) = int_bits(datatype);
if is_standard_layout(elem_size, &order, bit_offset, bit_precision) {
return Ok(match elem_size {
1 => bulk_decode!(raw, count, order, i8, i16),
2 => bulk_decode!(raw, count, order, i16, i16),
4 => bulk_decode!(raw, count, order, i32, i16),
8 => bulk_decode!(raw, count, order, i64, i16),
_ => unreachable!(),
});
}
#[expect(
clippy::cast_possible_truncation,
reason = "read_as_i16 narrows each stored value to the requested i16"
)]
Ok(read_as_i32(raw, datatype)?
.into_iter()
.map(|v| v as i16)
.collect())
}
pub fn read_as_u32(raw: &[u8], datatype: &Datatype) -> Result<Vec<u32>, FormatError> {
ensure_numeric(datatype, "FixedPoint (unsigned)")?;
let elem_size = get_size(datatype);
if elem_size == 0 || !raw.len().is_multiple_of(elem_size) {
return Err(FormatError::DataSizeMismatch {
expected: 0,
actual: raw.len(),
});
}
let count = raw.len() / elem_size;
let order = get_byte_order(datatype);
let (bit_offset, bit_precision) = int_bits(datatype);
if is_standard_layout(elem_size, &order, bit_offset, bit_precision) {
return Ok(match elem_size {
1 => bulk_decode!(raw, count, order, u8, u32),
2 => bulk_decode!(raw, count, order, u16, u32),
4 => bulk_decode!(raw, count, order, u32, u32),
8 => bulk_decode!(raw, count, order, u64, u32),
_ => unreachable!(),
});
}
#[expect(
clippy::cast_possible_truncation,
reason = "read_as_u32 narrows each stored value to the requested u32"
)]
Ok(read_as_u64(raw, datatype)?
.into_iter()
.map(|v| v as u32)
.collect())
}
pub fn read_as_u16(raw: &[u8], datatype: &Datatype) -> Result<Vec<u16>, FormatError> {
ensure_numeric(datatype, "FixedPoint (unsigned)")?;
let elem_size = get_size(datatype);
if elem_size == 0 || !raw.len().is_multiple_of(elem_size) {
return Err(FormatError::DataSizeMismatch {
expected: 0,
actual: raw.len(),
});
}
let count = raw.len() / elem_size;
let order = get_byte_order(datatype);
let (bit_offset, bit_precision) = int_bits(datatype);
if is_standard_layout(elem_size, &order, bit_offset, bit_precision) {
return Ok(match elem_size {
1 => bulk_decode!(raw, count, order, u8, u16),
2 => bulk_decode!(raw, count, order, u16, u16),
4 => bulk_decode!(raw, count, order, u32, u16),
8 => bulk_decode!(raw, count, order, u64, u16),
_ => unreachable!(),
});
}
#[expect(
clippy::cast_possible_truncation,
reason = "read_as_u16 narrows each stored value to the requested u16"
)]
Ok(read_as_u64(raw, datatype)?
.into_iter()
.map(|v| v as u16)
.collect())
}
pub fn read_as_strings(raw: &[u8], datatype: &Datatype) -> Result<Vec<String>, FormatError> {
match datatype {
Datatype::String { size, padding, .. } => {
let elem_size = *size as usize;
if elem_size == 0 {
return Ok(Vec::new());
}
if !raw.len().is_multiple_of(elem_size) {
return Err(FormatError::DataSizeMismatch {
expected: 0,
actual: raw.len(),
});
}
let count = raw.len() / elem_size;
let mut result = Vec::with_capacity(count);
for i in 0..count {
let chunk = &raw[i * elem_size..(i + 1) * elem_size];
let s = match padding {
crate::datatype::StringPadding::NullTerminate => {
let end = chunk.iter().position(|&b| b == 0).unwrap_or(chunk.len());
String::from_utf8_lossy(&chunk[..end]).into_owned()
}
crate::datatype::StringPadding::NullPad => {
let end = chunk.iter().rposition(|&b| b != 0).map_or(0, |p| p + 1);
String::from_utf8_lossy(&chunk[..end]).into_owned()
}
crate::datatype::StringPadding::SpacePad => {
let end = chunk.iter().rposition(|&b| b != b' ').map_or(0, |p| p + 1);
String::from_utf8_lossy(&chunk[..end]).into_owned()
}
};
result.push(s);
}
Ok(result)
}
_ => Err(FormatError::TypeMismatch {
expected: "String",
actual: datatype_name(datatype),
}),
}
}
fn reorder_bytes(bytes: &[u8], order: &DatatypeByteOrder) -> [u8; 8] {
let mut buf = [0u8; 8];
let len = bytes.len().min(8);
match order {
DatatypeByteOrder::LittleEndian | DatatypeByteOrder::Vax => {
buf[..len].copy_from_slice(&bytes[..len]);
}
DatatypeByteOrder::BigEndian => {
for i in 0..len {
buf[i] = bytes[len - 1 - i];
}
}
}
buf
}
fn read_f64_bytes(bytes: &[u8], order: &DatatypeByteOrder) -> f64 {
let buf = reorder_bytes(bytes, order);
f64::from_le_bytes(buf)
}
fn read_f32_bytes(bytes: &[u8], order: &DatatypeByteOrder) -> f32 {
let mut buf = [0u8; 4];
let len = bytes.len().min(4);
match order {
DatatypeByteOrder::LittleEndian | DatatypeByteOrder::Vax => {
buf[..len].copy_from_slice(&bytes[..len]);
}
DatatypeByteOrder::BigEndian => {
for i in 0..len {
buf[i] = bytes[len - 1 - i];
}
}
}
f32::from_le_bytes(buf)
}
fn int_bits(dt: &Datatype) -> (u16, u16) {
match dt {
Datatype::FixedPoint {
bit_offset,
bit_precision,
..
} => (*bit_offset, *bit_precision),
_ => {
let bits = u16::try_from(get_size(dt) * 8).unwrap_or(u16::MAX);
(0, bits)
}
}
}
fn read_raw_word(bytes: &[u8], size: usize, order: &DatatypeByteOrder) -> u64 {
let buf = reorder_bytes(bytes, order);
let mut val = 0u64;
for (i, &byte) in buf.iter().enumerate().take(size.min(8)) {
val |= (byte as u64) << (i * 8);
}
val
}
fn extract_unsigned_bits(raw: u64, bit_offset: u16, bit_precision: u16) -> u64 {
let off = u32::from(bit_offset);
let prec = u32::from(bit_precision);
let shifted = if off >= 64 { 0 } else { raw >> off };
if prec == 0 {
0
} else if prec >= 64 {
shifted
} else {
shifted & ((1u64 << prec) - 1)
}
}
fn read_unsigned_int(
bytes: &[u8],
size: usize,
order: &DatatypeByteOrder,
bit_offset: u16,
bit_precision: u16,
) -> u64 {
let raw = read_raw_word(bytes, size, order);
extract_unsigned_bits(raw, bit_offset, bit_precision)
}
#[expect(
clippy::cast_possible_wrap,
reason = "reinterprets raw bits as a signed integer; sign reinterpretation and \
sign-extension are the intended operations"
)]
fn read_signed_int(
bytes: &[u8],
size: usize,
order: &DatatypeByteOrder,
bit_offset: u16,
bit_precision: u16,
) -> i64 {
let magnitude = read_unsigned_int(bytes, size, order, bit_offset, bit_precision);
let prec = u32::from(bit_precision);
if prec == 0 || prec >= 64 {
magnitude as i64
} else {
let shift = 64 - prec;
((magnitude << shift) as i64) >> shift
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::dataspace::{Dataspace, DataspaceType};
use crate::datatype::{CharacterSet, StringPadding};
#[cfg(not(feature = "std"))]
use alloc::vec;
fn make_f64_le_type() -> Datatype {
Datatype::FloatingPoint {
size: 8,
byte_order: DatatypeByteOrder::LittleEndian,
bit_offset: 0,
bit_precision: 64,
exponent_location: 52,
exponent_size: 11,
mantissa_location: 0,
mantissa_size: 52,
exponent_bias: 1023,
}
}
fn make_f32_be_type() -> Datatype {
Datatype::FloatingPoint {
size: 4,
byte_order: DatatypeByteOrder::BigEndian,
bit_offset: 0,
bit_precision: 32,
exponent_location: 23,
exponent_size: 8,
mantissa_location: 0,
mantissa_size: 23,
exponent_bias: 127,
}
}
fn make_i32_le_type() -> Datatype {
Datatype::FixedPoint {
size: 4,
byte_order: DatatypeByteOrder::LittleEndian,
signed: true,
bit_offset: 0,
bit_precision: 32,
}
}
fn make_i16_le_type() -> Datatype {
Datatype::FixedPoint {
size: 2,
byte_order: DatatypeByteOrder::LittleEndian,
signed: true,
bit_offset: 0,
bit_precision: 16,
}
}
fn make_u8_type() -> Datatype {
Datatype::FixedPoint {
size: 1,
byte_order: DatatypeByteOrder::LittleEndian,
signed: false,
bit_offset: 0,
bit_precision: 8,
}
}
fn make_simple_dataspace(dims: &[u64]) -> Dataspace {
Dataspace {
space_type: DataspaceType::Simple,
rank: dims.len() as u8,
dimensions: dims.to_vec(),
max_dimensions: None,
}
}
#[test]
fn read_f64_compact() {
let dt = make_f64_le_type();
let ds = make_simple_dataspace(&[3]);
let mut data = Vec::new();
data.extend_from_slice(&1.0f64.to_le_bytes());
data.extend_from_slice(&2.0f64.to_le_bytes());
data.extend_from_slice(&3.0f64.to_le_bytes());
let layout = DataLayout::Compact { data: data.clone() };
let raw = read_raw_data(&[], &layout, &ds, &dt).unwrap();
assert_eq!(raw, data);
let values = read_as_f64(&raw, &dt).unwrap();
assert_eq!(values, vec![1.0, 2.0, 3.0]);
}
#[test]
fn read_i32_contiguous() {
let dt = make_i32_le_type();
let ds = make_simple_dataspace(&[4]);
let mut file_data = vec![0u8; 1024];
let offset = 256usize;
let vals: Vec<i32> = vec![10, -20, 30, -40];
for (i, v) in vals.iter().enumerate() {
let bytes = v.to_le_bytes();
file_data[offset + i * 4..offset + i * 4 + 4].copy_from_slice(&bytes);
}
let layout = DataLayout::Contiguous {
address: Some(offset as u64),
size: 16,
};
let raw = read_raw_data(&file_data, &layout, &ds, &dt).unwrap();
let result = read_as_i32(&raw, &dt).unwrap();
assert_eq!(result, vec![10, -20, 30, -40]);
}
#[test]
fn read_u8_data() {
let dt = make_u8_type();
let ds = make_simple_dataspace(&[5]);
let data = vec![10u8, 20, 30, 40, 50];
let layout = DataLayout::Compact { data: data.clone() };
let raw = read_raw_data(&[], &layout, &ds, &dt).unwrap();
let result = read_as_u64(&raw, &dt).unwrap();
assert_eq!(result, vec![10, 20, 30, 40, 50]);
}
#[test]
fn read_f32_be() {
let dt = make_f32_be_type();
let ds = make_simple_dataspace(&[2]);
let mut data = Vec::new();
data.extend_from_slice(&1.5f32.to_be_bytes());
data.extend_from_slice(&2.5f32.to_be_bytes());
let layout = DataLayout::Compact { data: data.clone() };
let raw = read_raw_data(&[], &layout, &ds, &dt).unwrap();
let result = read_as_f32(&raw, &dt).unwrap();
assert_eq!(result, vec![1.5, 2.5]);
}
#[test]
fn read_i16_le() {
let dt = make_i16_le_type();
let ds = make_simple_dataspace(&[3]);
let mut data = Vec::new();
data.extend_from_slice(&(-100i16).to_le_bytes());
data.extend_from_slice(&200i16.to_le_bytes());
data.extend_from_slice(&(-300i16).to_le_bytes());
let layout = DataLayout::Compact { data: data.clone() };
let raw = read_raw_data(&[], &layout, &ds, &dt).unwrap();
let result = read_as_i64(&raw, &dt).unwrap();
assert_eq!(result, vec![-100, 200, -300]);
}
#[test]
fn read_strings_compact() {
let dt = Datatype::String {
size: 5,
padding: StringPadding::NullPad,
charset: CharacterSet::Ascii,
};
let ds = make_simple_dataspace(&[2]);
let mut data = Vec::new();
data.extend_from_slice(b"hello");
data.extend_from_slice(b"hi\0\0\0");
let layout = DataLayout::Compact { data: data.clone() };
let raw = read_raw_data(&[], &layout, &ds, &dt).unwrap();
let result = read_as_strings(&raw, &dt).unwrap();
assert_eq!(result, vec!["hello", "hi"]);
}
#[test]
fn type_mismatch_f64_on_string() {
let dt = Datatype::String {
size: 4,
padding: StringPadding::NullTerminate,
charset: CharacterSet::Ascii,
};
let raw = vec![0u8; 8];
let err = read_as_f64(&raw, &dt).unwrap_err();
assert!(matches!(err, FormatError::TypeMismatch { .. }));
}
#[test]
fn size_mismatch_compact() {
let dt = make_f64_le_type();
let ds = make_simple_dataspace(&[3]);
let data = vec![0u8; 16]; let layout = DataLayout::Compact { data };
let err = read_raw_data(&[], &layout, &ds, &dt).unwrap_err();
assert!(matches!(err, FormatError::DataSizeMismatch { .. }));
}
#[test]
fn no_data_allocated() {
let dt = make_f64_le_type();
let ds = make_simple_dataspace(&[3]);
let layout = DataLayout::Contiguous {
address: None,
size: 24,
};
let err = read_raw_data(&[], &layout, &ds, &dt).unwrap_err();
assert!(matches!(err, FormatError::NoDataAllocated));
}
#[test]
fn string_type_mismatch_on_read_as_strings() {
let dt = make_i32_le_type();
let raw = vec![0u8; 8];
let err = read_as_strings(&raw, &dt).unwrap_err();
assert!(matches!(err, FormatError::TypeMismatch { .. }));
}
#[test]
fn read_f64_from_i32() {
let dt = make_i32_le_type();
let mut raw = Vec::new();
raw.extend_from_slice(&42i32.to_le_bytes());
raw.extend_from_slice(&(-7i32).to_le_bytes());
let result = read_as_f64(&raw, &dt).unwrap();
assert_eq!(result, vec![42.0, -7.0]);
}
#[test]
fn read_strings_space_padded() {
let dt = Datatype::String {
size: 8,
padding: StringPadding::SpacePad,
charset: CharacterSet::Ascii,
};
let raw = b"hello world ";
let result = read_as_strings(raw, &dt).unwrap();
assert_eq!(result, vec!["hello", "world"]);
}
#[test]
fn read_strings_null_terminated() {
let dt = Datatype::String {
size: 6,
padding: StringPadding::NullTerminate,
charset: CharacterSet::Ascii,
};
let raw = b"abc\0\0\0de\0\0\0\0";
let result = read_as_strings(raw, &dt).unwrap();
assert_eq!(result, vec!["abc", "de"]);
}
#[cfg(feature = "std")]
#[test]
fn streaming_contiguous_matches_buffered() {
use crate::source::{BytesSource, ReadSeekSource};
let dt = make_f64_le_type();
let ds = make_simple_dataspace(&[3]);
let mut file_data = vec![0u8; 1024];
let offset = 256usize;
for (i, v) in [1.0f64, 2.0, 3.0].iter().enumerate() {
file_data[offset + i * 8..offset + i * 8 + 8].copy_from_slice(&v.to_le_bytes());
}
let layout = DataLayout::Contiguous {
address: Some(offset as u64),
size: 24,
};
let buffered = read_raw_data_full(&file_data, &layout, &ds, &dt, None, 8, 8).unwrap();
let from_mem = read_raw_data_full_from_source(
&BytesSource::new(&file_data),
&layout,
&ds,
&dt,
None,
8,
8,
)
.unwrap();
let from_seek = read_raw_data_full_from_source(
&ReadSeekSource::new(std::io::Cursor::new(file_data)).unwrap(),
&layout,
&ds,
&dt,
None,
8,
8,
)
.unwrap();
assert_eq!(buffered, from_mem);
assert_eq!(buffered, from_seek);
assert_eq!(read_as_f64(&from_seek, &dt).unwrap(), vec![1.0, 2.0, 3.0]);
}
#[cfg(feature = "std")]
#[test]
fn streaming_compact_matches_buffered() {
use crate::source::BytesSource;
let dt = make_f64_le_type();
let ds = make_simple_dataspace(&[2]);
let mut data = Vec::new();
for v in [7.0f64, 8.0] {
data.extend_from_slice(&v.to_le_bytes());
}
let layout = DataLayout::Compact { data };
let buffered = read_raw_data_full(&[], &layout, &ds, &dt, None, 8, 8).unwrap();
let streamed = read_raw_data_full_from_source(
&BytesSource::new(Vec::new()),
&layout,
&ds,
&dt,
None,
8,
8,
)
.unwrap();
assert_eq!(buffered, streamed);
}
#[cfg(feature = "std")]
#[test]
fn streaming_contiguous_error_parity() {
use crate::source::BytesSource;
let dt = make_f64_le_type();
let ds = make_simple_dataspace(&[3]);
let layout = DataLayout::Contiguous {
address: None,
size: 24,
};
let buffered = read_raw_data_full(&[], &layout, &ds, &dt, None, 8, 8);
let streamed = read_raw_data_full_from_source(
&BytesSource::new(Vec::new()),
&layout,
&ds,
&dt,
None,
8,
8,
);
assert!(matches!(buffered, Err(FormatError::NoDataAllocated)));
assert!(matches!(streamed, Err(FormatError::NoDataAllocated)));
}
#[test]
fn unsigned_subbyte_precision_masks_padding() {
let dt = Datatype::FixedPoint {
size: 2,
byte_order: DatatypeByteOrder::LittleEndian,
signed: false,
bit_offset: 0,
bit_precision: 12,
};
let raw = 0xF123u16.to_le_bytes();
assert_eq!(read_as_u64(&raw, &dt).unwrap(), vec![0x123]);
}
#[test]
fn unsigned_bit_offset_shifts_value() {
let dt = Datatype::FixedPoint {
size: 2,
byte_order: DatatypeByteOrder::LittleEndian,
signed: false,
bit_offset: 4,
bit_precision: 8,
};
let raw = 0xCAB7u16.to_le_bytes();
assert_eq!(read_as_u64(&raw, &dt).unwrap(), vec![0xAB]);
}
#[test]
fn signed_subbyte_precision_sign_extends() {
let dt = Datatype::FixedPoint {
size: 1,
byte_order: DatatypeByteOrder::LittleEndian,
signed: true,
bit_offset: 0,
bit_precision: 4,
};
assert_eq!(read_as_i64(&[0x3F], &dt).unwrap(), vec![-1]);
assert_eq!(read_as_i64(&[0x07], &dt).unwrap(), vec![7]);
}
#[test]
fn standard_width_integers_unchanged() {
let i32t = make_i32_le_type();
assert_eq!(
read_as_i64(&(-5i32).to_le_bytes(), &i32t).unwrap(),
vec![-5]
);
let i16t = make_i16_le_type();
assert_eq!(
read_as_i64(&(-12345i16).to_le_bytes(), &i16t).unwrap(),
vec![-12345]
);
let u8t = make_u8_type();
assert_eq!(read_as_u64(&[200u8], &u8t).unwrap(), vec![200]);
}
fn make_int(size: u32, signed: bool, be: bool) -> Datatype {
Datatype::FixedPoint {
size,
byte_order: if be {
DatatypeByteOrder::BigEndian
} else {
DatatypeByteOrder::LittleEndian
},
signed,
bit_offset: 0,
bit_precision: (size * 8) as u16,
}
}
#[test]
fn fast_path_big_endian_signed_matches_values() {
let dt = make_int(4, true, true);
let vals = [1i32, -1, 2_000_000_000, -2_000_000_000, 0];
let mut raw = Vec::new();
for v in vals {
raw.extend_from_slice(&v.to_be_bytes());
}
assert_eq!(
read_as_i64(&raw, &dt).unwrap(),
vals.iter().map(|&v| v as i64).collect::<Vec<_>>()
);
assert_eq!(read_as_i32(&raw, &dt).unwrap(), vals.to_vec());
assert_eq!(
read_as_f64(&raw, &dt).unwrap(),
vals.iter().map(|&v| v as f64).collect::<Vec<_>>()
);
}
#[test]
fn fast_path_unsigned_read_as_signed_reinterprets() {
let dt = make_int(4, false, false);
let raw = 0xFFFF_FFFFu32.to_le_bytes();
assert_eq!(read_as_i64(&raw, &dt).unwrap(), vec![-1]);
assert_eq!(read_as_u64(&raw, &dt).unwrap(), vec![0xFFFF_FFFF]);
}
#[test]
fn fast_path_narrowing_readers_match_wide_then_narrow() {
for be in [false, true] {
let i64t = make_int(8, true, be);
let vals = [1i64, -1, 70_000, -70_000, i64::from(i32::MAX)];
let mut raw = Vec::new();
for v in vals {
if be {
raw.extend_from_slice(&v.to_be_bytes());
} else {
raw.extend_from_slice(&v.to_le_bytes());
}
}
let wide = read_as_i64(&raw, &i64t).unwrap();
let i16s = read_as_i16(&raw, &i64t).unwrap();
assert_eq!(
i16s,
wide.iter().map(|&v| v as i16).collect::<Vec<_>>(),
"i16 narrow be={be}"
);
let u64t = make_int(8, false, be);
let uwide = read_as_u64(&raw, &u64t).unwrap();
assert_eq!(
read_as_u16(&raw, &u64t).unwrap(),
uwide.iter().map(|&v| v as u16).collect::<Vec<_>>(),
"u16 narrow be={be}"
);
assert_eq!(
read_as_u32(&raw, &u64t).unwrap(),
uwide.iter().map(|&v| v as u32).collect::<Vec<_>>(),
"u32 narrow be={be}"
);
}
}
#[test]
fn fast_path_all_widths_roundtrip_f32() {
let f4 = read_as_f32(&1.5f32.to_be_bytes(), &make_f32_be_type()).unwrap();
assert_eq!(f4, vec![1.5]);
let f8le = Datatype::FloatingPoint {
size: 8,
byte_order: DatatypeByteOrder::LittleEndian,
bit_offset: 0,
bit_precision: 64,
exponent_location: 52,
exponent_size: 11,
mantissa_location: 0,
mantissa_size: 52,
exponent_bias: 1023,
};
assert_eq!(
read_as_f32(&2.25f64.to_le_bytes(), &f8le).unwrap(),
vec![2.25f32]
);
for (size, be) in [(1u32, false), (2, true), (4, false), (8, true)] {
let dt = make_int(size, true, be);
let v: i64 = -3;
let bytes = if be { v.to_be_bytes() } else { v.to_le_bytes() };
let raw = if be {
&bytes[8 - size as usize..]
} else {
&bytes[..size as usize]
};
assert_eq!(read_as_f32(raw, &dt).unwrap(), vec![-3.0f32]);
}
}
}