netcdf-reader 0.6.0

Pure-Rust NetCDF-3 classic and NetCDF-4 (HDF5-backed) file reader
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
//! Data reading for classic (CDF-1/2/5) NetCDF files.
//!
//! Two layout types:
//! - **Non-record variables**: contiguous data at the offset stored in the variable header.
//! - **Record variables**: data is interleaved across records. Each record contains one
//!   slice from every record variable, in the order they appear in the header. The total
//!   record size is the sum of all record variables' vsize values (each padded to 4-byte
//!   boundary in CDF-1/2).

use ndarray::{ArrayD, IxDyn};
#[cfg(feature = "rayon")]
use rayon::prelude::*;

use crate::error::{Error, Result};
use crate::types::{NcType, NcVariable};

use super::storage::ClassicStorage;

/// Trait for types that can be read from classic NetCDF data.
pub trait NcReadType: Clone + Default + Send + 'static {
    /// The NetCDF type this Rust type corresponds to.
    fn nc_type() -> NcType;

    /// Read a single element from big-endian bytes.
    fn from_be_bytes(bytes: &[u8]) -> Result<Self>;

    /// Size in bytes of one element.
    fn element_size() -> usize;

    /// Bulk decode `count` elements from a contiguous big-endian byte slice.
    ///
    /// Default implementation falls back to per-element decoding. Types with
    /// multi-byte elements override this with an optimized bulk path using
    /// `chunks_exact` + byte-swap (on LE hosts) or `copy_nonoverlapping`
    /// (on BE hosts).
    fn decode_bulk_be(raw: &[u8], count: usize) -> Result<Vec<Self>> {
        let elem_size = Self::element_size();
        let needed = count.checked_mul(elem_size).ok_or_else(|| {
            Error::InvalidData("classic decode byte count exceeds platform usize".to_string())
        })?;
        if raw.len() < needed {
            return Err(Error::InvalidData(format!(
                "need {} bytes for {} elements, got {}",
                needed,
                count,
                raw.len()
            )));
        }
        let mut values = Vec::with_capacity(count);
        for i in 0..count {
            let start = i * elem_size;
            values.push(Self::from_be_bytes(&raw[start..start + elem_size])?);
        }
        Ok(values)
    }

    /// Bulk decode elements from a contiguous big-endian byte slice into a
    /// caller-provided destination buffer.
    fn decode_bulk_be_into(raw: &[u8], dst: &mut [Self]) -> Result<()> {
        let elem_size = Self::element_size();
        let needed = dst.len().checked_mul(elem_size).ok_or_else(|| {
            Error::InvalidData("classic decode byte count exceeds platform usize".to_string())
        })?;
        if raw.len() < needed {
            return Err(Error::InvalidData(format!(
                "need {} bytes for {} elements, got {}",
                needed,
                dst.len(),
                raw.len()
            )));
        }
        for (out, chunk) in dst.iter_mut().zip(raw[..needed].chunks_exact(elem_size)) {
            *out = Self::from_be_bytes(chunk)?;
        }
        Ok(())
    }
}

macro_rules! impl_nc_read_type {
    ($ty:ty, $nc_type:expr, $size:expr) => {
        impl NcReadType for $ty {
            fn nc_type() -> NcType {
                $nc_type
            }

            fn from_be_bytes(bytes: &[u8]) -> Result<Self> {
                if bytes.len() < $size {
                    return Err(Error::InvalidData(format!(
                        "need {} bytes for {}, got {}",
                        $size,
                        stringify!($ty),
                        bytes.len()
                    )));
                }
                let mut arr = [0u8; $size];
                arr.copy_from_slice(&bytes[..$size]);
                Ok(<$ty>::from_be_bytes(arr))
            }

            fn element_size() -> usize {
                $size
            }

            fn decode_bulk_be(raw: &[u8], count: usize) -> Result<Vec<Self>> {
                let total_bytes = count.checked_mul($size).ok_or_else(|| {
                    Error::InvalidData(
                        "classic decode byte count exceeds platform usize".to_string(),
                    )
                })?;
                if raw.len() < total_bytes {
                    return Err(Error::InvalidData(format!(
                        "need {} bytes for {} elements of {}, got {}",
                        total_bytes,
                        count,
                        stringify!($ty),
                        raw.len()
                    )));
                }
                let bytes = &raw[..total_bytes];
                #[cfg(target_endian = "big")]
                {
                    // Native BE: memcpy is safe for any element size.
                    let mut values = Vec::<$ty>::with_capacity(count);
                    unsafe {
                        std::ptr::copy_nonoverlapping(
                            bytes.as_ptr(),
                            values.as_mut_ptr() as *mut u8,
                            total_bytes,
                        );
                        values.set_len(count);
                    }
                    Ok(values)
                }
                #[cfg(target_endian = "little")]
                {
                    // LE host reading BE data: chunks_exact + byte-swap.
                    Ok(bytes
                        .chunks_exact($size)
                        .map(|chunk| {
                            let mut arr = [0u8; $size];
                            arr.copy_from_slice(chunk);
                            <$ty>::from_be_bytes(arr)
                        })
                        .collect())
                }
            }

            fn decode_bulk_be_into(raw: &[u8], dst: &mut [Self]) -> Result<()> {
                let total_bytes = dst.len().checked_mul($size).ok_or_else(|| {
                    Error::InvalidData(
                        "classic decode byte count exceeds platform usize".to_string(),
                    )
                })?;
                if raw.len() < total_bytes {
                    return Err(Error::InvalidData(format!(
                        "need {} bytes for {} elements of {}, got {}",
                        total_bytes,
                        dst.len(),
                        stringify!($ty),
                        raw.len()
                    )));
                }
                let bytes = &raw[..total_bytes];
                #[cfg(target_endian = "big")]
                {
                    unsafe {
                        std::ptr::copy_nonoverlapping(
                            bytes.as_ptr(),
                            dst.as_mut_ptr() as *mut u8,
                            total_bytes,
                        );
                    }
                    Ok(())
                }
                #[cfg(target_endian = "little")]
                {
                    for (out, chunk) in dst.iter_mut().zip(bytes.chunks_exact($size)) {
                        let mut arr = [0u8; $size];
                        arr.copy_from_slice(chunk);
                        *out = <$ty>::from_be_bytes(arr);
                    }
                    Ok(())
                }
            }
        }
    };
}

impl_nc_read_type!(i8, NcType::Byte, 1);
impl_nc_read_type!(i16, NcType::Short, 2);
impl_nc_read_type!(i32, NcType::Int, 4);
impl_nc_read_type!(f32, NcType::Float, 4);
impl_nc_read_type!(f64, NcType::Double, 8);
impl_nc_read_type!(u8, NcType::UByte, 1);
impl_nc_read_type!(u16, NcType::UShort, 2);
impl_nc_read_type!(u32, NcType::UInt, 4);
impl_nc_read_type!(i64, NcType::Int64, 8);
impl_nc_read_type!(u64, NcType::UInt64, 8);

/// Read the entire data for a non-record variable into an ndarray.
///
/// The data is located at a contiguous region starting at `var.data_offset`
/// with total size `var.data_size`.
pub fn read_non_record_variable<T: NcReadType>(
    file_data: &[u8],
    var: &NcVariable,
) -> Result<ArrayD<T>> {
    if var.is_record_var {
        return Err(Error::InvalidData(
            "use read_record_variable for record variables".to_string(),
        ));
    }

    let offset = crate::types::checked_usize_from_u64(var.data_offset, "variable data offset")?;
    let total_elements = checked_non_record_element_count(var)?;
    let elem_size = T::element_size();
    let total_bytes = total_elements.checked_mul(elem_size).ok_or_else(|| {
        Error::InvalidData(format!(
            "variable '{}' size in bytes exceeds platform usize",
            var.name
        ))
    })?;

    let end = offset.checked_add(total_bytes).ok_or_else(|| {
        Error::InvalidData(format!(
            "variable '{}' byte range exceeds platform usize",
            var.name
        ))
    })?;
    if end > file_data.len() {
        return Err(Error::InvalidData(format!(
            "variable '{}' data extends beyond file: offset={}, size={}, file_len={}",
            var.name,
            offset,
            total_bytes,
            file_data.len()
        )));
    }

    let data_slice = &file_data[offset..end];
    let values = T::decode_bulk_be(data_slice, total_elements)?;

    let shape: Vec<usize> = var
        .shape()
        .iter()
        .map(|&s| crate::types::checked_usize_from_u64(s, "variable dimension"))
        .collect::<Result<Vec<_>>>()?;
    if shape.is_empty() {
        // Scalar variable.
        ArrayD::from_shape_vec(IxDyn(&[]), values)
    } else {
        ArrayD::from_shape_vec(IxDyn(&shape), values)
    }
    .map_err(|e| Error::InvalidData(format!("failed to create array: {}", e)))
}

/// Read the entire data for a non-record variable from range-backed storage.
pub(crate) fn read_non_record_variable_from_storage<T: NcReadType>(
    storage: &ClassicStorage,
    var: &NcVariable,
) -> Result<ArrayD<T>> {
    if var.is_record_var {
        return Err(Error::InvalidData(
            "use read_record_variable_from_storage for record variables".to_string(),
        ));
    }

    let total_elements = checked_non_record_element_count(var)?;
    let total_bytes = variable_data_bytes::<T>(var.name.as_str(), total_elements)?;
    let data = storage.read_range(var.data_offset, total_bytes)?;
    let values = T::decode_bulk_be(data.as_ref(), total_elements)?;
    let shape = checked_variable_shape(var)?;

    ArrayD::from_shape_vec(IxDyn(&shape), values)
        .map_err(|e| Error::InvalidData(format!("failed to create array: {}", e)))
}

/// Read the entire data for a non-record variable using Rayon for large reads.
#[cfg(feature = "rayon")]
pub(crate) fn read_non_record_variable_parallel_from_storage<T: NcReadType>(
    storage: &ClassicStorage,
    var: &NcVariable,
) -> Result<ArrayD<T>> {
    if var.is_record_var {
        return Err(Error::InvalidData(
            "use read_record_variable_parallel_from_storage for record variables".to_string(),
        ));
    }

    let total_elements = checked_non_record_element_count(var)?;
    let total_bytes = variable_data_bytes::<T>(var.name.as_str(), total_elements)?;
    let policy = storage.parallel_read_policy();
    if total_bytes < policy.min_bytes || total_elements == 0 {
        return read_non_record_variable_from_storage(storage, var);
    }

    let values = read_contiguous_range_parallel::<T>(
        storage,
        var.data_offset,
        total_elements,
        policy.target_chunk_bytes,
    )?;
    let shape = checked_variable_shape(var)?;

    ArrayD::from_shape_vec(IxDyn(&shape), values)
        .map_err(|e| Error::InvalidData(format!("failed to create array: {}", e)))
}

/// Read the entire data for a non-record variable into a caller-provided buffer.
pub fn read_non_record_variable_into<T: NcReadType>(
    file_data: &[u8],
    var: &NcVariable,
    dst: &mut [T],
) -> Result<()> {
    if var.is_record_var {
        return Err(Error::InvalidData(
            "use read_record_variable_into for record variables".to_string(),
        ));
    }

    let total_elements = checked_non_record_element_count(var)?;
    if dst.len() != total_elements {
        return Err(Error::InvalidData(format!(
            "destination has {} elements, variable '{}' requires {}",
            dst.len(),
            var.name,
            total_elements
        )));
    }

    let offset = crate::types::checked_usize_from_u64(var.data_offset, "variable data offset")?;
    let elem_size = T::element_size();
    let total_bytes = total_elements.checked_mul(elem_size).ok_or_else(|| {
        Error::InvalidData(format!(
            "variable '{}' size in bytes exceeds platform usize",
            var.name
        ))
    })?;

    let end = offset.checked_add(total_bytes).ok_or_else(|| {
        Error::InvalidData(format!(
            "variable '{}' byte range exceeds platform usize",
            var.name
        ))
    })?;
    if end > file_data.len() {
        return Err(Error::InvalidData(format!(
            "variable '{}' data extends beyond file: offset={}, size={}, file_len={}",
            var.name,
            offset,
            total_bytes,
            file_data.len()
        )));
    }

    T::decode_bulk_be_into(&file_data[offset..end], dst)
}

/// Read a non-record variable from range-backed storage into a caller-provided buffer.
pub(crate) fn read_non_record_variable_into_from_storage<T: NcReadType>(
    storage: &ClassicStorage,
    var: &NcVariable,
    dst: &mut [T],
) -> Result<()> {
    if var.is_record_var {
        return Err(Error::InvalidData(
            "use read_record_variable_into_from_storage for record variables".to_string(),
        ));
    }

    let total_elements = checked_non_record_element_count(var)?;
    if dst.len() != total_elements {
        return Err(Error::InvalidData(format!(
            "destination has {} elements, variable '{}' requires {}",
            dst.len(),
            var.name,
            total_elements
        )));
    }

    let total_bytes = variable_data_bytes::<T>(var.name.as_str(), total_elements)?;
    let data = storage.read_range(var.data_offset, total_bytes)?;
    T::decode_bulk_be_into(data.as_ref(), dst)
}

/// Read the entire data for a record variable into an ndarray.
///
/// Record variables are interleaved: for each of `numrecs` records, every record
/// variable contributes `record_size` bytes (padded to 4-byte alignment for CDF-1/2).
/// The `record_stride` is the total size of one record across all record variables.
///
/// Parameters:
/// - `file_data`: the raw file bytes
/// - `var`: the record variable to read
/// - `numrecs`: number of records (from the file header)
/// - `record_stride`: total bytes per record (sum of all record variables' padded vsizes)
pub fn read_record_variable<T: NcReadType>(
    file_data: &[u8],
    var: &NcVariable,
    numrecs: u64,
    record_stride: u64,
) -> Result<ArrayD<T>> {
    if !var.is_record_var {
        return Err(Error::InvalidData(
            "use read_non_record_variable for non-record variables".to_string(),
        ));
    }

    let elem_size = T::element_size();
    let base_offset =
        crate::types::checked_usize_from_u64(var.data_offset, "record variable data offset")?;
    let numrecs_usize = crate::types::checked_usize_from_u64(numrecs, "record count")?;
    let record_stride_usize = crate::types::checked_usize_from_u64(record_stride, "record stride")?;

    // Shape: the first dimension is the unlimited dimension, replaced by numrecs.
    let mut shape: Vec<usize> = var
        .shape()
        .iter()
        .map(|&s| crate::types::checked_usize_from_u64(s, "record variable dimension"))
        .collect::<Result<Vec<_>>>()?;
    if shape.is_empty() {
        return Err(Error::InvalidData(
            "record variable must have at least one dimension".to_string(),
        ));
    }
    shape[0] = numrecs_usize;

    // Number of elements per record (product of all dims except the first).
    let elements_per_record: usize = shape[1..].iter().product::<usize>().max(1);
    let bytes_per_record = elements_per_record.checked_mul(elem_size).ok_or_else(|| {
        Error::InvalidData(format!(
            "record variable '{}' bytes per record exceed platform usize",
            var.name
        ))
    })?;
    let total_elements = numrecs_usize
        .checked_mul(elements_per_record)
        .ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' element count exceeds platform usize",
                var.name
            ))
        })?;

    let mut values = Vec::with_capacity(total_elements);

    for rec in 0..numrecs_usize {
        let rec_offset = base_offset
            .checked_add(rec.checked_mul(record_stride_usize).ok_or_else(|| {
                Error::InvalidData(format!(
                    "record variable '{}' byte offset exceeds platform usize",
                    var.name
                ))
            })?)
            .ok_or_else(|| {
                Error::InvalidData(format!(
                    "record variable '{}' byte offset exceeds platform usize",
                    var.name
                ))
            })?;
        let rec_end = rec_offset.checked_add(bytes_per_record).ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' record range exceeds platform usize",
                var.name
            ))
        })?;
        if rec_end > file_data.len() {
            return Err(Error::InvalidData(format!(
                "record {} for variable '{}' extends beyond file",
                rec, var.name
            )));
        }
        let rec_slice = &file_data[rec_offset..rec_end];
        let rec_values = T::decode_bulk_be(rec_slice, elements_per_record)?;
        values.extend(rec_values);
    }

    ArrayD::from_shape_vec(IxDyn(&shape), values)
        .map_err(|e| Error::InvalidData(format!("failed to create array: {}", e)))
}

/// Read the entire data for a record variable from range-backed storage.
pub(crate) fn read_record_variable_from_storage<T: NcReadType>(
    storage: &ClassicStorage,
    var: &NcVariable,
    numrecs: u64,
    record_stride: u64,
) -> Result<ArrayD<T>> {
    if !var.is_record_var {
        return Err(Error::InvalidData(
            "use read_non_record_variable_from_storage for non-record variables".to_string(),
        ));
    }

    let shape = checked_record_shape(var, numrecs)?;
    let elements_per_record = checked_record_elements_per_record(var)?;
    let bytes_per_record = variable_data_bytes::<T>(var.name.as_str(), elements_per_record)?;
    let numrecs_usize = crate::types::checked_usize_from_u64(numrecs, "record count")?;
    let total_elements = numrecs_usize
        .checked_mul(elements_per_record)
        .ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' element count exceeds platform usize",
                var.name
            ))
        })?;
    let mut values = Vec::with_capacity(total_elements);

    for rec in 0..numrecs {
        let rec_offset = record_byte_offset(var, rec, record_stride)?;
        let rec_slice = storage.read_range(rec_offset, bytes_per_record)?;
        let rec_values = T::decode_bulk_be(rec_slice.as_ref(), elements_per_record)?;
        values.extend(rec_values);
    }

    ArrayD::from_shape_vec(IxDyn(&shape), values)
        .map_err(|e| Error::InvalidData(format!("failed to create array: {}", e)))
}

/// Read the entire data for a record variable using Rayon for large reads.
#[cfg(feature = "rayon")]
pub(crate) fn read_record_variable_parallel_from_storage<T: NcReadType>(
    storage: &ClassicStorage,
    var: &NcVariable,
    numrecs: u64,
    record_stride: u64,
) -> Result<ArrayD<T>> {
    if !var.is_record_var {
        return Err(Error::InvalidData(
            "use read_non_record_variable_parallel_from_storage for non-record variables"
                .to_string(),
        ));
    }

    let shape = checked_record_shape(var, numrecs)?;
    let elements_per_record = checked_record_elements_per_record(var)?;
    let bytes_per_record = variable_data_bytes::<T>(var.name.as_str(), elements_per_record)?;
    let numrecs_usize = crate::types::checked_usize_from_u64(numrecs, "record count")?;
    let total_elements = numrecs_usize
        .checked_mul(elements_per_record)
        .ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' element count exceeds platform usize",
                var.name
            ))
        })?;
    let logical_bytes = numrecs_usize.checked_mul(bytes_per_record).ok_or_else(|| {
        Error::InvalidData(format!(
            "record variable '{}' logical byte count exceeds platform usize",
            var.name
        ))
    })?;
    let policy = storage.parallel_read_policy();
    if logical_bytes < policy.min_bytes || numrecs_usize <= 1 {
        return read_record_variable_from_storage(storage, var, numrecs, record_stride);
    }

    let records_per_chunk = (policy.target_chunk_bytes / bytes_per_record.max(1)).max(1);
    let elements_per_chunk = records_per_chunk
        .checked_mul(elements_per_record)
        .ok_or_else(|| {
            Error::InvalidData(
                "classic record chunk element count exceeds platform usize".to_string(),
            )
        })?;
    let mut values = vec![T::default(); total_elements];
    let chunk_plan = RecordChunkReadPlan {
        var,
        record_stride,
        elements_per_record,
        bytes_per_record,
    };
    values
        .par_chunks_mut(elements_per_chunk)
        .enumerate()
        .try_for_each(|(chunk, dst)| {
            let first_record = chunk.checked_mul(records_per_chunk).ok_or_else(|| {
                Error::InvalidData("classic record chunk offset exceeds platform usize".to_string())
            })?;
            let records = dst.len().checked_div(elements_per_record).ok_or_else(|| {
                Error::InvalidData("classic record elements per record is zero".to_string())
            })?;
            read_record_chunk_into::<T>(storage, &chunk_plan, first_record as u64, records, dst)
        })?;

    ArrayD::from_shape_vec(IxDyn(&shape), values)
        .map_err(|e| Error::InvalidData(format!("failed to create array: {}", e)))
}

/// Read the entire data for a record variable into a caller-provided buffer.
pub fn read_record_variable_into<T: NcReadType>(
    file_data: &[u8],
    var: &NcVariable,
    numrecs: u64,
    record_stride: u64,
    dst: &mut [T],
) -> Result<()> {
    if !var.is_record_var {
        return Err(Error::InvalidData(
            "use read_non_record_variable_into for non-record variables".to_string(),
        ));
    }

    let elem_size = T::element_size();
    let base_offset =
        crate::types::checked_usize_from_u64(var.data_offset, "record variable data offset")?;
    let numrecs_usize = crate::types::checked_usize_from_u64(numrecs, "record count")?;
    let record_stride_usize = crate::types::checked_usize_from_u64(record_stride, "record stride")?;

    if var.dimensions.is_empty() {
        return Err(Error::InvalidData(
            "record variable must have at least one dimension".to_string(),
        ));
    }

    let elements_per_record = checked_record_elements_per_record(var)?;
    let bytes_per_record = elements_per_record.checked_mul(elem_size).ok_or_else(|| {
        Error::InvalidData(format!(
            "record variable '{}' bytes per record exceed platform usize",
            var.name
        ))
    })?;
    let total_elements = numrecs_usize
        .checked_mul(elements_per_record)
        .ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' element count exceeds platform usize",
                var.name
            ))
        })?;
    if dst.len() != total_elements {
        return Err(Error::InvalidData(format!(
            "destination has {} elements, variable '{}' requires {}",
            dst.len(),
            var.name,
            total_elements
        )));
    }

    for rec in 0..numrecs_usize {
        let rec_offset = base_offset
            .checked_add(rec.checked_mul(record_stride_usize).ok_or_else(|| {
                Error::InvalidData(format!(
                    "record variable '{}' byte offset exceeds platform usize",
                    var.name
                ))
            })?)
            .ok_or_else(|| {
                Error::InvalidData(format!(
                    "record variable '{}' byte offset exceeds platform usize",
                    var.name
                ))
            })?;
        let rec_end = rec_offset.checked_add(bytes_per_record).ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' record range exceeds platform usize",
                var.name
            ))
        })?;
        if rec_end > file_data.len() {
            return Err(Error::InvalidData(format!(
                "record {} for variable '{}' extends beyond file",
                rec, var.name
            )));
        }

        let dst_start = rec.checked_mul(elements_per_record).ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' destination offset exceeds platform usize",
                var.name
            ))
        })?;
        let dst_end = dst_start.checked_add(elements_per_record).ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' destination range exceeds platform usize",
                var.name
            ))
        })?;
        T::decode_bulk_be_into(
            &file_data[rec_offset..rec_end],
            &mut dst[dst_start..dst_end],
        )?;
    }

    Ok(())
}

/// Read a record variable from range-backed storage into a caller-provided buffer.
pub(crate) fn read_record_variable_into_from_storage<T: NcReadType>(
    storage: &ClassicStorage,
    var: &NcVariable,
    numrecs: u64,
    record_stride: u64,
    dst: &mut [T],
) -> Result<()> {
    if !var.is_record_var {
        return Err(Error::InvalidData(
            "use read_non_record_variable_into_from_storage for non-record variables".to_string(),
        ));
    }

    if var.dimensions.is_empty() {
        return Err(Error::InvalidData(
            "record variable must have at least one dimension".to_string(),
        ));
    }

    let elements_per_record = checked_record_elements_per_record(var)?;
    let bytes_per_record = variable_data_bytes::<T>(var.name.as_str(), elements_per_record)?;
    let numrecs_usize = crate::types::checked_usize_from_u64(numrecs, "record count")?;
    let total_elements = numrecs_usize
        .checked_mul(elements_per_record)
        .ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' element count exceeds platform usize",
                var.name
            ))
        })?;
    if dst.len() != total_elements {
        return Err(Error::InvalidData(format!(
            "destination has {} elements, variable '{}' requires {}",
            dst.len(),
            var.name,
            total_elements
        )));
    }

    for rec in 0..numrecs {
        let rec_offset = record_byte_offset(var, rec, record_stride)?;
        let rec_slice = storage.read_range(rec_offset, bytes_per_record)?;
        let dst_start = crate::types::checked_usize_from_u64(rec, "record index")?
            .checked_mul(elements_per_record)
            .ok_or_else(|| {
                Error::InvalidData(format!(
                    "record variable '{}' destination offset exceeds platform usize",
                    var.name
                ))
            })?;
        let dst_end = dst_start.checked_add(elements_per_record).ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' destination range exceeds platform usize",
                var.name
            ))
        })?;
        T::decode_bulk_be_into(rec_slice.as_ref(), &mut dst[dst_start..dst_end])?;
    }

    Ok(())
}

/// Compute the record stride: total bytes per record across all record variables.
///
/// Each record variable's per-record contribution is its `record_size` (already stored
/// as vsize from the header), padded to 4-byte boundary.
pub fn compute_record_stride(variables: &[NcVariable]) -> u64 {
    variables
        .iter()
        .filter(|v| v.is_record_var)
        .map(|v| {
            let size = v.record_size;
            // Pad each variable's per-record size to 4-byte boundary.
            let rem = size % 4;
            if rem == 0 {
                size
            } else {
                size + (4 - rem)
            }
        })
        .sum()
}

fn checked_non_record_element_count(var: &NcVariable) -> Result<usize> {
    let mut total = 1u64;
    for dim in &var.dimensions {
        total = total.checked_mul(dim.size).ok_or_else(|| {
            Error::InvalidData("variable element count overflows u64".to_string())
        })?;
    }
    crate::types::checked_usize_from_u64(total, "variable element count")
}

pub(crate) fn checked_variable_shape(var: &NcVariable) -> Result<Vec<usize>> {
    var.shape()
        .iter()
        .map(|&s| crate::types::checked_usize_from_u64(s, "variable dimension"))
        .collect::<Result<Vec<_>>>()
}

fn checked_record_shape(var: &NcVariable, numrecs: u64) -> Result<Vec<usize>> {
    let mut shape: Vec<usize> = var
        .shape()
        .iter()
        .map(|&s| crate::types::checked_usize_from_u64(s, "record variable dimension"))
        .collect::<Result<Vec<_>>>()?;
    if shape.is_empty() {
        return Err(Error::InvalidData(
            "record variable must have at least one dimension".to_string(),
        ));
    }
    shape[0] = crate::types::checked_usize_from_u64(numrecs, "record count")?;
    Ok(shape)
}

fn checked_record_elements_per_record(var: &NcVariable) -> Result<usize> {
    let mut elements = 1usize;
    for dim in var.dimensions.iter().skip(1) {
        let size = crate::types::checked_usize_from_u64(dim.size, "record variable dimension")?;
        elements = elements.checked_mul(size).ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' elements per record exceed platform usize",
                var.name
            ))
        })?;
    }
    Ok(elements)
}

pub(crate) fn variable_data_bytes<T: NcReadType>(
    var_name: &str,
    element_count: usize,
) -> Result<usize> {
    element_count.checked_mul(T::element_size()).ok_or_else(|| {
        Error::InvalidData(format!(
            "variable '{var_name}' size in bytes exceeds platform usize"
        ))
    })
}

pub(crate) fn record_byte_offset(var: &NcVariable, record: u64, record_stride: u64) -> Result<u64> {
    var.data_offset
        .checked_add(record.checked_mul(record_stride).ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' byte offset exceeds u64",
                var.name
            ))
        })?)
        .ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' byte offset exceeds u64",
                var.name
            ))
        })
}

#[cfg(feature = "rayon")]
pub(crate) fn read_contiguous_range_parallel<T: NcReadType>(
    storage: &ClassicStorage,
    base_offset: u64,
    total_elements: usize,
    target_chunk_bytes: usize,
) -> Result<Vec<T>> {
    if total_elements == 0 {
        return Ok(Vec::new());
    }

    let elem_size = T::element_size();
    let elements_per_chunk = (target_chunk_bytes / elem_size.max(1)).max(1);
    let mut values = vec![T::default(); total_elements];
    values
        .par_chunks_mut(elements_per_chunk)
        .enumerate()
        .try_for_each(|(chunk, dst)| {
            let start_element = chunk.checked_mul(elements_per_chunk).ok_or_else(|| {
                Error::InvalidData(
                    "classic parallel chunk offset exceeds platform usize".to_string(),
                )
            })?;
            let byte_offset = crate::types::checked_mul_u64(
                start_element as u64,
                elem_size as u64,
                "classic parallel byte offset",
            )?;
            let offset = base_offset.checked_add(byte_offset).ok_or_else(|| {
                Error::InvalidData("classic parallel byte offset exceeds u64".to_string())
            })?;
            let bytes = variable_data_bytes::<T>("parallel chunk", dst.len())?;
            let data = storage.read_range(offset, bytes)?;
            T::decode_bulk_be_into(data.as_ref(), dst)
        })?;

    Ok(values)
}

#[cfg(feature = "rayon")]
struct RecordChunkReadPlan<'a> {
    var: &'a NcVariable,
    record_stride: u64,
    elements_per_record: usize,
    bytes_per_record: usize,
}

#[cfg(feature = "rayon")]
fn read_record_chunk_into<T: NcReadType>(
    storage: &ClassicStorage,
    plan: &RecordChunkReadPlan<'_>,
    first_record: u64,
    records: usize,
    dst: &mut [T],
) -> Result<()> {
    if records == 0 {
        return Ok(());
    }

    let expected_elements = records
        .checked_mul(plan.elements_per_record)
        .ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' chunk element count exceeds platform usize",
                plan.var.name
            ))
        })?;
    if dst.len() != expected_elements {
        return Err(Error::InvalidData(format!(
            "record variable '{}' chunk destination has {} elements, expected {}",
            plan.var.name,
            dst.len(),
            expected_elements
        )));
    }

    if plan.record_stride == plan.bytes_per_record as u64 {
        let offset = record_byte_offset(plan.var, first_record, plan.record_stride)?;
        let bytes = records.checked_mul(plan.bytes_per_record).ok_or_else(|| {
            Error::InvalidData(format!(
                "record variable '{}' chunk byte count exceeds platform usize",
                plan.var.name
            ))
        })?;
        let data = storage.read_range(offset, bytes)?;
        return T::decode_bulk_be_into(data.as_ref(), dst);
    }

    for ordinal in 0..records {
        let record = first_record
            .checked_add(ordinal as u64)
            .ok_or_else(|| Error::InvalidData("classic record index exceeds u64".to_string()))?;
        let offset = record_byte_offset(plan.var, record, plan.record_stride)?;
        let data = storage.read_range(offset, plan.bytes_per_record)?;
        let dst_start = ordinal
            .checked_mul(plan.elements_per_record)
            .ok_or_else(|| {
                Error::InvalidData(format!(
                    "record variable '{}' chunk destination offset exceeds platform usize",
                    plan.var.name
                ))
            })?;
        let dst_end = dst_start
            .checked_add(plan.elements_per_record)
            .ok_or_else(|| {
                Error::InvalidData(format!(
                    "record variable '{}' chunk destination range exceeds platform usize",
                    plan.var.name
                ))
            })?;
        T::decode_bulk_be_into(data.as_ref(), &mut dst[dst_start..dst_end])?;
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::types::NcDimension;

    #[test]
    fn read_non_record_1d_float() {
        // Create a fake file with 3 floats starting at offset 100.
        let mut file_data = vec![0u8; 200];
        let values = [1.0f32, 2.0f32, 3.0f32];
        for (i, &v) in values.iter().enumerate() {
            let bytes = v.to_be_bytes();
            file_data[100 + i * 4..100 + i * 4 + 4].copy_from_slice(&bytes);
        }

        let var = NcVariable {
            name: "temp".to_string(),
            dimensions: vec![NcDimension {
                name: "x".to_string(),
                size: 3,
                is_unlimited: false,
            }],
            dtype: NcType::Float,
            attributes: vec![],
            data_offset: 100,
            _data_size: 12,
            is_record_var: false,
            record_size: 0,
        };

        let arr: ArrayD<f32> = read_non_record_variable(&file_data, &var).unwrap();
        assert_eq!(arr.shape(), &[3]);
        assert_eq!(arr[[0]], 1.0f32);
        assert_eq!(arr[[1]], 2.0f32);
        assert_eq!(arr[[2]], 3.0f32);
    }

    #[test]
    fn non_record_variable_into_copies_values() {
        let mut file_data = vec![0u8; 200];
        let values = [1.0f32, 2.0f32, 3.0f32];
        for (i, &v) in values.iter().enumerate() {
            file_data[100 + i * 4..100 + i * 4 + 4].copy_from_slice(&v.to_be_bytes());
        }

        let var = NcVariable {
            name: "temp".to_string(),
            dimensions: vec![NcDimension {
                name: "x".to_string(),
                size: 3,
                is_unlimited: false,
            }],
            dtype: NcType::Float,
            attributes: vec![],
            data_offset: 100,
            _data_size: 12,
            is_record_var: false,
            record_size: 0,
        };

        let mut dst = [0.0f32; 3];
        read_non_record_variable_into(&file_data, &var, &mut dst).unwrap();
        assert_eq!(dst, values);
    }

    #[test]
    fn read_non_record_2d_int() {
        // 2x3 array of i32 at offset 0
        let values: Vec<i32> = vec![10, 20, 30, 40, 50, 60];
        let mut file_data = Vec::new();
        for &v in &values {
            file_data.extend_from_slice(&v.to_be_bytes());
        }

        let var = NcVariable {
            name: "grid".to_string(),
            dimensions: vec![
                NcDimension {
                    name: "y".to_string(),
                    size: 2,
                    is_unlimited: false,
                },
                NcDimension {
                    name: "x".to_string(),
                    size: 3,
                    is_unlimited: false,
                },
            ],
            dtype: NcType::Int,
            attributes: vec![],
            data_offset: 0,
            _data_size: 24,
            is_record_var: false,
            record_size: 0,
        };

        let arr: ArrayD<i32> = read_non_record_variable(&file_data, &var).unwrap();
        assert_eq!(arr.shape(), &[2, 3]);
        assert_eq!(arr[[0, 0]], 10);
        assert_eq!(arr[[0, 2]], 30);
        assert_eq!(arr[[1, 0]], 40);
        assert_eq!(arr[[1, 2]], 60);
    }

    #[test]
    fn read_non_record_variable_into_rejects_wrong_destination_len() {
        let var = NcVariable {
            name: "grid".to_string(),
            dimensions: vec![NcDimension {
                name: "x".to_string(),
                size: 3,
                is_unlimited: false,
            }],
            dtype: NcType::Float,
            attributes: vec![],
            data_offset: 0,
            _data_size: 12,
            is_record_var: false,
            record_size: 0,
        };

        let mut dst = [0.0f32; 2];
        let err = read_non_record_variable_into(&[0; 12], &var, &mut dst).unwrap_err();
        assert!(matches!(err, Error::InvalidData(_)));
    }

    #[test]
    fn record_stride_sums_padded_record_variables() {
        let vars = vec![
            NcVariable {
                name: "a".to_string(),
                dimensions: vec![],
                dtype: NcType::Float,
                attributes: vec![],
                data_offset: 0,
                _data_size: 0,
                is_record_var: true,
                record_size: 20, // 5 floats
            },
            NcVariable {
                name: "b".to_string(),
                dimensions: vec![],
                dtype: NcType::Short,
                attributes: vec![],
                data_offset: 0,
                _data_size: 0,
                is_record_var: true,
                record_size: 6, // 3 shorts -> padded to 8
            },
            NcVariable {
                name: "c".to_string(),
                dimensions: vec![],
                dtype: NcType::Double,
                attributes: vec![],
                data_offset: 0,
                _data_size: 100,
                is_record_var: false, // not a record var, should be excluded
                record_size: 0,
            },
        ];
        // a: 20 (already 4-aligned), b: 6 -> 8 = total 28
        assert_eq!(compute_record_stride(&vars), 28);
    }

    #[test]
    fn record_variable_reads_all_records() {
        // Single record variable "temp" with shape [time, x] where x=2.
        // 3 records, each with 2 floats = 8 bytes per record.
        // Record stride = 8 (only one record var, already 4-aligned).
        let mut file_data = vec![0u8; 200];
        let base = 100usize;
        let record_values: Vec<Vec<f32>> = vec![vec![1.0, 2.0], vec![3.0, 4.0], vec![5.0, 6.0]];
        for (rec, vals) in record_values.iter().enumerate() {
            for (i, &v) in vals.iter().enumerate() {
                let offset = base + rec * 8 + i * 4;
                file_data[offset..offset + 4].copy_from_slice(&v.to_be_bytes());
            }
        }

        let var = NcVariable {
            name: "temp".to_string(),
            dimensions: vec![
                NcDimension {
                    name: "time".to_string(),
                    size: 0, // unlimited
                    is_unlimited: true,
                },
                NcDimension {
                    name: "x".to_string(),
                    size: 2,
                    is_unlimited: false,
                },
            ],
            dtype: NcType::Float,
            attributes: vec![],
            data_offset: 100,
            _data_size: 0,
            is_record_var: true,
            record_size: 8,
        };

        let arr: ArrayD<f32> = read_record_variable(&file_data, &var, 3, 8).unwrap();
        assert_eq!(arr.shape(), &[3, 2]);
        assert_eq!(arr[[0, 0]], 1.0);
        assert_eq!(arr[[0, 1]], 2.0);
        assert_eq!(arr[[1, 0]], 3.0);
        assert_eq!(arr[[2, 1]], 6.0);
    }

    #[test]
    fn record_variable_into_copies_values() {
        let mut file_data = vec![0u8; 200];
        let base = 100usize;
        let record_values: Vec<Vec<f32>> = vec![vec![1.0, 2.0], vec![3.0, 4.0], vec![5.0, 6.0]];
        for (rec, vals) in record_values.iter().enumerate() {
            for (i, &v) in vals.iter().enumerate() {
                let offset = base + rec * 8 + i * 4;
                file_data[offset..offset + 4].copy_from_slice(&v.to_be_bytes());
            }
        }

        let var = NcVariable {
            name: "temp".to_string(),
            dimensions: vec![
                NcDimension {
                    name: "time".to_string(),
                    size: 0,
                    is_unlimited: true,
                },
                NcDimension {
                    name: "x".to_string(),
                    size: 2,
                    is_unlimited: false,
                },
            ],
            dtype: NcType::Float,
            attributes: vec![],
            data_offset: 100,
            _data_size: 0,
            is_record_var: true,
            record_size: 8,
        };

        let mut dst = [0.0f32; 6];
        read_record_variable_into(&file_data, &var, 3, 8, &mut dst).unwrap();
        assert_eq!(dst, [1.0, 2.0, 3.0, 4.0, 5.0, 6.0]);
    }

    #[test]
    fn read_record_variable_into_rejects_wrong_destination_len() {
        let var = NcVariable {
            name: "temp".to_string(),
            dimensions: vec![
                NcDimension {
                    name: "time".to_string(),
                    size: 0,
                    is_unlimited: true,
                },
                NcDimension {
                    name: "x".to_string(),
                    size: 2,
                    is_unlimited: false,
                },
            ],
            dtype: NcType::Float,
            attributes: vec![],
            data_offset: 0,
            _data_size: 0,
            is_record_var: true,
            record_size: 8,
        };

        let mut dst = [0.0f32; 5];
        let err = read_record_variable_into(&[0; 24], &var, 3, 8, &mut dst).unwrap_err();
        assert!(matches!(err, Error::InvalidData(_)));
    }

    #[test]
    fn read_non_record_variable_rejects_element_count_overflow() {
        let var = NcVariable {
            name: "huge".to_string(),
            dimensions: vec![
                NcDimension {
                    name: "y".to_string(),
                    size: u64::MAX,
                    is_unlimited: false,
                },
                NcDimension {
                    name: "x".to_string(),
                    size: 2,
                    is_unlimited: false,
                },
            ],
            dtype: NcType::Float,
            attributes: vec![],
            data_offset: 0,
            _data_size: 0,
            is_record_var: false,
            record_size: 0,
        };

        let err = read_non_record_variable::<f32>(&[], &var).unwrap_err();
        assert!(matches!(err, Error::InvalidData(_)));
    }

    #[test]
    fn read_record_variable_rejects_record_offset_overflow() {
        let var = NcVariable {
            name: "huge_record".to_string(),
            dimensions: vec![
                NcDimension {
                    name: "time".to_string(),
                    size: 0,
                    is_unlimited: true,
                },
                NcDimension {
                    name: "x".to_string(),
                    size: 1,
                    is_unlimited: false,
                },
            ],
            dtype: NcType::Float,
            attributes: vec![],
            data_offset: u64::MAX,
            _data_size: 0,
            is_record_var: true,
            record_size: 4,
        };

        let err = read_record_variable::<f32>(&[], &var, 1, 4).unwrap_err();
        assert!(matches!(err, Error::InvalidData(_)));
    }
}