scirs2-io 0.4.2

Input/Output utilities module for SciRS2 (scirs2-io)
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
//! Encoding and decoding routines for columnar data.
//!
//! Implements run-length encoding, dictionary encoding, and delta encoding
//! for efficient column-oriented storage.

use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use std::collections::HashMap;
use std::io::{Read, Write};

use crate::error::{IoError, Result};

use super::types::{ColumnData, EncodingType};

// =============================================================================
// Plain encoding
// =============================================================================

/// Write f64 values in plain encoding
pub fn write_plain_f64<W: Write>(writer: &mut W, data: &[f64]) -> Result<()> {
    for &val in data {
        writer
            .write_f64::<LittleEndian>(val)
            .map_err(|e| IoError::FileError(format!("Failed to write f64: {}", e)))?;
    }
    Ok(())
}

/// Read f64 values in plain encoding
pub fn read_plain_f64<R: Read>(reader: &mut R, count: usize) -> Result<Vec<f64>> {
    let mut data = Vec::with_capacity(count);
    for _ in 0..count {
        let val = reader
            .read_f64::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read f64: {}", e)))?;
        data.push(val);
    }
    Ok(data)
}

/// Write i64 values in plain encoding
pub fn write_plain_i64<W: Write>(writer: &mut W, data: &[i64]) -> Result<()> {
    for &val in data {
        writer
            .write_i64::<LittleEndian>(val)
            .map_err(|e| IoError::FileError(format!("Failed to write i64: {}", e)))?;
    }
    Ok(())
}

/// Read i64 values in plain encoding
pub fn read_plain_i64<R: Read>(reader: &mut R, count: usize) -> Result<Vec<i64>> {
    let mut data = Vec::with_capacity(count);
    for _ in 0..count {
        let val = reader
            .read_i64::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read i64: {}", e)))?;
        data.push(val);
    }
    Ok(data)
}

/// Write string values in plain encoding (length-prefixed)
pub fn write_plain_str<W: Write>(writer: &mut W, data: &[String]) -> Result<()> {
    for s in data {
        let bytes = s.as_bytes();
        writer
            .write_u32::<LittleEndian>(bytes.len() as u32)
            .map_err(|e| IoError::FileError(format!("Failed to write string length: {}", e)))?;
        writer
            .write_all(bytes)
            .map_err(|e| IoError::FileError(format!("Failed to write string data: {}", e)))?;
    }
    Ok(())
}

/// Read string values in plain encoding
pub fn read_plain_str<R: Read>(reader: &mut R, count: usize) -> Result<Vec<String>> {
    let mut data = Vec::with_capacity(count);
    for _ in 0..count {
        let len = reader
            .read_u32::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read string length: {}", e)))?
            as usize;
        let mut buf = vec![0u8; len];
        reader
            .read_exact(&mut buf)
            .map_err(|e| IoError::FormatError(format!("Failed to read string data: {}", e)))?;
        let s = String::from_utf8(buf)
            .map_err(|e| IoError::FormatError(format!("Invalid UTF-8 string: {}", e)))?;
        data.push(s);
    }
    Ok(data)
}

/// Write bool values in plain encoding (packed bits)
pub fn write_plain_bool<W: Write>(writer: &mut W, data: &[bool]) -> Result<()> {
    // Pack booleans into bytes, 8 per byte
    let num_bytes = (data.len() + 7) / 8;
    let mut packed = vec![0u8; num_bytes];
    for (i, &val) in data.iter().enumerate() {
        if val {
            packed[i / 8] |= 1 << (i % 8);
        }
    }
    writer
        .write_all(&packed)
        .map_err(|e| IoError::FileError(format!("Failed to write bool data: {}", e)))?;
    Ok(())
}

/// Read bool values in plain encoding
pub fn read_plain_bool<R: Read>(reader: &mut R, count: usize) -> Result<Vec<bool>> {
    let num_bytes = (count + 7) / 8;
    let mut packed = vec![0u8; num_bytes];
    reader
        .read_exact(&mut packed)
        .map_err(|e| IoError::FormatError(format!("Failed to read bool data: {}", e)))?;
    let mut data = Vec::with_capacity(count);
    for i in 0..count {
        data.push((packed[i / 8] >> (i % 8)) & 1 == 1);
    }
    Ok(data)
}

// =============================================================================
// Run-length encoding
// =============================================================================

/// Write f64 values with RLE
pub fn write_rle_f64<W: Write>(writer: &mut W, data: &[f64]) -> Result<()> {
    if data.is_empty() {
        return Ok(());
    }
    let mut i = 0;
    while i < data.len() {
        let val = data[i];
        let mut run_len: u32 = 1;
        while i + (run_len as usize) < data.len() && data[i + (run_len as usize)] == val {
            run_len += 1;
        }
        writer
            .write_u32::<LittleEndian>(run_len)
            .map_err(|e| IoError::FileError(format!("Failed to write RLE run length: {}", e)))?;
        writer
            .write_f64::<LittleEndian>(val)
            .map_err(|e| IoError::FileError(format!("Failed to write RLE value: {}", e)))?;
        i += run_len as usize;
    }
    Ok(())
}

/// Read f64 values with RLE
pub fn read_rle_f64<R: Read>(reader: &mut R, total_count: usize) -> Result<Vec<f64>> {
    let mut data = Vec::with_capacity(total_count);
    while data.len() < total_count {
        let run_len = reader
            .read_u32::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read RLE run length: {}", e)))?
            as usize;
        let val = reader
            .read_f64::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read RLE value: {}", e)))?;
        for _ in 0..run_len {
            data.push(val);
        }
    }
    if data.len() != total_count {
        return Err(IoError::FormatError(format!(
            "RLE decoded {} values, expected {}",
            data.len(),
            total_count
        )));
    }
    Ok(data)
}

/// Write i64 values with RLE
pub fn write_rle_i64<W: Write>(writer: &mut W, data: &[i64]) -> Result<()> {
    if data.is_empty() {
        return Ok(());
    }
    let mut i = 0;
    while i < data.len() {
        let val = data[i];
        let mut run_len: u32 = 1;
        while i + (run_len as usize) < data.len() && data[i + (run_len as usize)] == val {
            run_len += 1;
        }
        writer
            .write_u32::<LittleEndian>(run_len)
            .map_err(|e| IoError::FileError(format!("Failed to write RLE run length: {}", e)))?;
        writer
            .write_i64::<LittleEndian>(val)
            .map_err(|e| IoError::FileError(format!("Failed to write RLE value: {}", e)))?;
        i += run_len as usize;
    }
    Ok(())
}

/// Read i64 values with RLE
pub fn read_rle_i64<R: Read>(reader: &mut R, total_count: usize) -> Result<Vec<i64>> {
    let mut data = Vec::with_capacity(total_count);
    while data.len() < total_count {
        let run_len = reader
            .read_u32::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read RLE run length: {}", e)))?
            as usize;
        let val = reader
            .read_i64::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read RLE value: {}", e)))?;
        for _ in 0..run_len {
            data.push(val);
        }
    }
    if data.len() != total_count {
        return Err(IoError::FormatError(format!(
            "RLE decoded {} values, expected {}",
            data.len(),
            total_count
        )));
    }
    Ok(data)
}

/// Write string values with RLE
pub fn write_rle_str<W: Write>(writer: &mut W, data: &[String]) -> Result<()> {
    if data.is_empty() {
        return Ok(());
    }
    let mut i = 0;
    while i < data.len() {
        let val = &data[i];
        let mut run_len: u32 = 1;
        while i + (run_len as usize) < data.len() && &data[i + (run_len as usize)] == val {
            run_len += 1;
        }
        writer
            .write_u32::<LittleEndian>(run_len)
            .map_err(|e| IoError::FileError(format!("Failed to write RLE run length: {}", e)))?;
        let bytes = val.as_bytes();
        writer
            .write_u32::<LittleEndian>(bytes.len() as u32)
            .map_err(|e| IoError::FileError(format!("Failed to write RLE string length: {}", e)))?;
        writer
            .write_all(bytes)
            .map_err(|e| IoError::FileError(format!("Failed to write RLE string data: {}", e)))?;
        i += run_len as usize;
    }
    Ok(())
}

/// Read string values with RLE
pub fn read_rle_str<R: Read>(reader: &mut R, total_count: usize) -> Result<Vec<String>> {
    let mut data = Vec::with_capacity(total_count);
    while data.len() < total_count {
        let run_len = reader
            .read_u32::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read RLE run length: {}", e)))?
            as usize;
        let str_len = reader
            .read_u32::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read RLE string length: {}", e)))?
            as usize;
        let mut buf = vec![0u8; str_len];
        reader
            .read_exact(&mut buf)
            .map_err(|e| IoError::FormatError(format!("Failed to read RLE string data: {}", e)))?;
        let s = String::from_utf8(buf)
            .map_err(|e| IoError::FormatError(format!("Invalid UTF-8 in RLE string: {}", e)))?;
        for _ in 0..run_len {
            data.push(s.clone());
        }
    }
    if data.len() != total_count {
        return Err(IoError::FormatError(format!(
            "RLE decoded {} values, expected {}",
            data.len(),
            total_count
        )));
    }
    Ok(data)
}

/// Write bool values with RLE
pub fn write_rle_bool<W: Write>(writer: &mut W, data: &[bool]) -> Result<()> {
    if data.is_empty() {
        return Ok(());
    }
    let mut i = 0;
    while i < data.len() {
        let val = data[i];
        let mut run_len: u32 = 1;
        while i + (run_len as usize) < data.len() && data[i + (run_len as usize)] == val {
            run_len += 1;
        }
        writer
            .write_u32::<LittleEndian>(run_len)
            .map_err(|e| IoError::FileError(format!("Failed to write RLE run length: {}", e)))?;
        writer
            .write_u8(if val { 1 } else { 0 })
            .map_err(|e| IoError::FileError(format!("Failed to write RLE bool value: {}", e)))?;
        i += run_len as usize;
    }
    Ok(())
}

/// Read bool values with RLE
pub fn read_rle_bool<R: Read>(reader: &mut R, total_count: usize) -> Result<Vec<bool>> {
    let mut data = Vec::with_capacity(total_count);
    while data.len() < total_count {
        let run_len = reader
            .read_u32::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read RLE run length: {}", e)))?
            as usize;
        let val = reader
            .read_u8()
            .map_err(|e| IoError::FormatError(format!("Failed to read RLE bool value: {}", e)))?
            != 0;
        for _ in 0..run_len {
            data.push(val);
        }
    }
    if data.len() != total_count {
        return Err(IoError::FormatError(format!(
            "RLE decoded {} values, expected {}",
            data.len(),
            total_count
        )));
    }
    Ok(data)
}

// =============================================================================
// Dictionary encoding (for strings)
// =============================================================================

/// Write string values with dictionary encoding
pub fn write_dict_str<W: Write>(writer: &mut W, data: &[String]) -> Result<()> {
    // Build dictionary
    let mut dictionary: Vec<String> = Vec::new();
    let mut dict_map: HashMap<String, u32> = HashMap::new();
    let mut indices: Vec<u32> = Vec::with_capacity(data.len());

    for s in data {
        let idx = if let Some(&existing) = dict_map.get(s) {
            existing
        } else {
            let new_idx = dictionary.len() as u32;
            dict_map.insert(s.clone(), new_idx);
            dictionary.push(s.clone());
            new_idx
        };
        indices.push(idx);
    }

    // Write dictionary size
    writer
        .write_u32::<LittleEndian>(dictionary.len() as u32)
        .map_err(|e| IoError::FileError(format!("Failed to write dictionary size: {}", e)))?;

    // Write dictionary entries
    for entry in &dictionary {
        let bytes = entry.as_bytes();
        writer
            .write_u32::<LittleEndian>(bytes.len() as u32)
            .map_err(|e| IoError::FileError(format!("Failed to write dict entry length: {}", e)))?;
        writer
            .write_all(bytes)
            .map_err(|e| IoError::FileError(format!("Failed to write dict entry: {}", e)))?;
    }

    // Write indices
    for &idx in &indices {
        writer
            .write_u32::<LittleEndian>(idx)
            .map_err(|e| IoError::FileError(format!("Failed to write dict index: {}", e)))?;
    }

    Ok(())
}

/// Read string values with dictionary encoding
pub fn read_dict_str<R: Read>(reader: &mut R, count: usize) -> Result<Vec<String>> {
    // Read dictionary
    let dict_size = reader
        .read_u32::<LittleEndian>()
        .map_err(|e| IoError::FormatError(format!("Failed to read dictionary size: {}", e)))?
        as usize;

    let mut dictionary = Vec::with_capacity(dict_size);
    for _ in 0..dict_size {
        let len = reader
            .read_u32::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read dict entry length: {}", e)))?
            as usize;
        let mut buf = vec![0u8; len];
        reader
            .read_exact(&mut buf)
            .map_err(|e| IoError::FormatError(format!("Failed to read dict entry: {}", e)))?;
        let s = String::from_utf8(buf)
            .map_err(|e| IoError::FormatError(format!("Invalid UTF-8 in dict entry: {}", e)))?;
        dictionary.push(s);
    }

    // Read indices
    let mut data = Vec::with_capacity(count);
    for _ in 0..count {
        let idx = reader
            .read_u32::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read dict index: {}", e)))?
            as usize;
        if idx >= dictionary.len() {
            return Err(IoError::FormatError(format!(
                "Dictionary index {} out of range (dict size {})",
                idx,
                dictionary.len()
            )));
        }
        data.push(dictionary[idx].clone());
    }

    Ok(data)
}

// =============================================================================
// Delta encoding (for sorted numeric columns)
// =============================================================================

/// Write f64 values with delta encoding
pub fn write_delta_f64<W: Write>(writer: &mut W, data: &[f64]) -> Result<()> {
    if data.is_empty() {
        return Ok(());
    }
    // Write first value
    writer
        .write_f64::<LittleEndian>(data[0])
        .map_err(|e| IoError::FileError(format!("Failed to write delta base: {}", e)))?;
    // Write deltas
    for i in 1..data.len() {
        let delta = data[i] - data[i - 1];
        writer
            .write_f64::<LittleEndian>(delta)
            .map_err(|e| IoError::FileError(format!("Failed to write delta: {}", e)))?;
    }
    Ok(())
}

/// Read f64 values with delta encoding
pub fn read_delta_f64<R: Read>(reader: &mut R, count: usize) -> Result<Vec<f64>> {
    if count == 0 {
        return Ok(Vec::new());
    }
    let mut data = Vec::with_capacity(count);
    let base = reader
        .read_f64::<LittleEndian>()
        .map_err(|e| IoError::FormatError(format!("Failed to read delta base: {}", e)))?;
    data.push(base);
    for _ in 1..count {
        let delta = reader
            .read_f64::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read delta: {}", e)))?;
        let prev = data[data.len() - 1];
        data.push(prev + delta);
    }
    Ok(data)
}

/// Write i64 values with delta encoding
pub fn write_delta_i64<W: Write>(writer: &mut W, data: &[i64]) -> Result<()> {
    if data.is_empty() {
        return Ok(());
    }
    writer
        .write_i64::<LittleEndian>(data[0])
        .map_err(|e| IoError::FileError(format!("Failed to write delta base: {}", e)))?;
    for i in 1..data.len() {
        let delta = data[i].wrapping_sub(data[i - 1]);
        writer
            .write_i64::<LittleEndian>(delta)
            .map_err(|e| IoError::FileError(format!("Failed to write delta: {}", e)))?;
    }
    Ok(())
}

/// Read i64 values with delta encoding
pub fn read_delta_i64<R: Read>(reader: &mut R, count: usize) -> Result<Vec<i64>> {
    if count == 0 {
        return Ok(Vec::new());
    }
    let mut data = Vec::with_capacity(count);
    let base = reader
        .read_i64::<LittleEndian>()
        .map_err(|e| IoError::FormatError(format!("Failed to read delta base: {}", e)))?;
    data.push(base);
    for _ in 1..count {
        let delta = reader
            .read_i64::<LittleEndian>()
            .map_err(|e| IoError::FormatError(format!("Failed to read delta: {}", e)))?;
        let prev = data[data.len() - 1];
        data.push(prev.wrapping_add(delta));
    }
    Ok(data)
}

// =============================================================================
// Unified encode/decode
// =============================================================================

/// Encode column data to a writer using the specified encoding
pub fn encode_column<W: Write>(
    writer: &mut W,
    data: &ColumnData,
    encoding: EncodingType,
) -> Result<()> {
    match (data, encoding) {
        // Plain
        (ColumnData::Float64(v), EncodingType::Plain) => write_plain_f64(writer, v),
        (ColumnData::Int64(v), EncodingType::Plain) => write_plain_i64(writer, v),
        (ColumnData::Str(v), EncodingType::Plain) => write_plain_str(writer, v),
        (ColumnData::Bool(v), EncodingType::Plain) => write_plain_bool(writer, v),
        // RLE
        (ColumnData::Float64(v), EncodingType::Rle) => write_rle_f64(writer, v),
        (ColumnData::Int64(v), EncodingType::Rle) => write_rle_i64(writer, v),
        (ColumnData::Str(v), EncodingType::Rle) => write_rle_str(writer, v),
        (ColumnData::Bool(v), EncodingType::Rle) => write_rle_bool(writer, v),
        // Dictionary (strings only)
        (ColumnData::Str(v), EncodingType::Dictionary) => write_dict_str(writer, v),
        // Delta (numeric only)
        (ColumnData::Float64(v), EncodingType::Delta) => write_delta_f64(writer, v),
        (ColumnData::Int64(v), EncodingType::Delta) => write_delta_i64(writer, v),
        // Unsupported combinations
        (data, enc) => Err(IoError::FormatError(format!(
            "Encoding {:?} not supported for column type {:?}",
            enc,
            data.type_tag()
        ))),
    }
}

/// Decode column data from a reader
pub fn decode_column<R: Read>(
    reader: &mut R,
    type_tag: super::types::ColumnTypeTag,
    encoding: EncodingType,
    count: usize,
) -> Result<ColumnData> {
    use super::types::ColumnTypeTag;

    match (type_tag, encoding) {
        // Plain
        (ColumnTypeTag::Float64, EncodingType::Plain) => {
            Ok(ColumnData::Float64(read_plain_f64(reader, count)?))
        }
        (ColumnTypeTag::Int64, EncodingType::Plain) => {
            Ok(ColumnData::Int64(read_plain_i64(reader, count)?))
        }
        (ColumnTypeTag::Str, EncodingType::Plain) => {
            Ok(ColumnData::Str(read_plain_str(reader, count)?))
        }
        (ColumnTypeTag::Bool, EncodingType::Plain) => {
            Ok(ColumnData::Bool(read_plain_bool(reader, count)?))
        }
        // RLE
        (ColumnTypeTag::Float64, EncodingType::Rle) => {
            Ok(ColumnData::Float64(read_rle_f64(reader, count)?))
        }
        (ColumnTypeTag::Int64, EncodingType::Rle) => {
            Ok(ColumnData::Int64(read_rle_i64(reader, count)?))
        }
        (ColumnTypeTag::Str, EncodingType::Rle) => {
            Ok(ColumnData::Str(read_rle_str(reader, count)?))
        }
        (ColumnTypeTag::Bool, EncodingType::Rle) => {
            Ok(ColumnData::Bool(read_rle_bool(reader, count)?))
        }
        // Dictionary
        (ColumnTypeTag::Str, EncodingType::Dictionary) => {
            Ok(ColumnData::Str(read_dict_str(reader, count)?))
        }
        // Delta
        (ColumnTypeTag::Float64, EncodingType::Delta) => {
            Ok(ColumnData::Float64(read_delta_f64(reader, count)?))
        }
        (ColumnTypeTag::Int64, EncodingType::Delta) => {
            Ok(ColumnData::Int64(read_delta_i64(reader, count)?))
        }
        // Unsupported
        (tt, enc) => Err(IoError::FormatError(format!(
            "Encoding {:?} not supported for type {:?}",
            enc, tt
        ))),
    }
}