darn-dmap 0.7.0

SuperDARN DMAP file format I/O
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

//! The generic [DMAP file format](https://radar-software-toolkit-rst.readthedocs.io/en/latest/references/general/dmap_data/).
//!
//! Defines [`DmapRecord`] which implements [`Record`], which can be used
//! for reading/writing DMAP files without checking that certain fields are or
//! are not present, or have a given type.

use crate::error::DmapError;
use crate::record::Record;
use crate::types::{DmapField, DmapType};
use indexmap::IndexMap;

#[derive(Debug, PartialEq, Clone)]
pub struct DmapRecord {
    pub data: IndexMap<String, DmapField>,
}

impl Record<'_> for DmapRecord {
    fn inner(self) -> IndexMap<String, DmapField> {
        self.data
    }
    fn get(&self, key: &str) -> Option<&DmapField> {
        self.data.get(key)
    }
    fn keys(&self) -> Vec<&String> {
        self.data.keys().collect()
    }
    fn new(fields: &mut IndexMap<String, DmapField>) -> Result<DmapRecord, DmapError> {
        Ok(DmapRecord {
            data: fields.to_owned(),
        })
    }
    fn is_metadata_field(_name: &str) -> bool {
        true
    }
    fn to_bytes(&self) -> Result<Vec<u8>, DmapError> {
        let mut data_bytes: Vec<u8> = vec![];
        let mut num_scalars: i32 = 0;
        let mut num_vectors: i32 = 0;

        // Do a first pass, to get all the scalar fields
        for (name, val) in self.data.iter() {
            if let x @ DmapField::Scalar(_) = val {
                data_bytes.extend(name.as_bytes());
                data_bytes.extend([0]); // null-terminate string
                data_bytes.append(&mut x.as_bytes());
                num_scalars += 1;
            }
        }
        // Do a second pass to convert all the vector fields
        for (name, val) in self.data.iter() {
            if let x @ DmapField::Vector(_) = val {
                data_bytes.extend(name.as_bytes());
                data_bytes.extend([0]); // null-terminate string
                data_bytes.append(&mut x.as_bytes());
                num_vectors += 1;
            }
        }
        let mut bytes: Vec<u8> = vec![];
        bytes.extend((65537_i32).as_bytes()); // No idea why this is what it is, copied from backscatter
        bytes.extend((data_bytes.len() as i32 + 16).as_bytes()); // +16 for code, length, num_scalars, num_vectors
        bytes.extend(num_scalars.as_bytes());
        bytes.extend(num_vectors.as_bytes());
        bytes.append(&mut data_bytes); // consumes data_bytes
        Ok(bytes)
    }
}

impl TryFrom<&mut IndexMap<String, DmapField>> for DmapRecord {
    type Error = DmapError;

    fn try_from(value: &mut IndexMap<String, DmapField>) -> Result<Self, Self::Error> {
        DmapRecord::new(value)
    }
}

impl TryFrom<IndexMap<String, DmapField>> for DmapRecord {
    type Error = DmapError;

    fn try_from(mut value: IndexMap<String, DmapField>) -> Result<Self, Self::Error> {
        DmapRecord::new(&mut value)
    }
}