bvreader 0.1.5

Reader for the BrainVision data format
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

//! 
//! This module contains functions for validating the BVFile struct
//! 

use super::{BVFile, Error};

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum IsValid {
    True,
    False(String),
}

/// Parses the invalid enum variant of IsValid to Error::ValidationError
/// 
/// Will always return Error, even if the value was IsValid::True
pub fn parse_invalid_to_error(value: &IsValid) -> Error {
    if let IsValid::False(ref msg) = value {
        Error::ValidationError(msg.to_string())
    } else {
        Error::ValidationError("".to_string())
    }
}

/// Validates that the number of channels is equal across all entries
/// 
/// 
pub fn validate_num_chan(bvfile: &BVFile) -> IsValid {
    let base_err = "Channel mismatch";
    let num_chan = bvfile.bv_header.num_channels;
    if num_chan != bvfile.bv_header.amp_channels {
        return IsValid::False(
            format!("{base_err}: channels in header {}, channels in AMP {}", num_chan, bvfile.bv_header.amp_channels)
        )
    };

    if num_chan != bvfile.bv_header.channel_info.len() {
        return IsValid::False(
            format!("{base_err}: channels in header {}, channels in channel info {}", num_chan, bvfile.bv_header.channel_info.len())
        )
    };

    if num_chan != bvfile.bv_data.data.len() {
        return IsValid::False(
            format!("{base_err}: channels in header {}, channels in data {}", num_chan, bvfile.bv_data.data.len())
        )
    };

    IsValid::True
}

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

    #[test]
    fn test_parse_validate_num_chan() {
        let input = "src/bv_reader/data/testfiles/01_header.vhdr";
        let bvfile = BVFile::from_header(input).unwrap();
        let output = validate_num_chan(&bvfile);

        let expected = IsValid::True;

        assert_eq!(output, expected);
    }


}