kff 0.9.0

Kmer File Format Rust parser
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

//! Utils function to write KFF

/* std use */

/* crate use */

/* project use */
use crate::error;

/// Define trait containts utils function to write kff
pub trait KffWrite {
    /// Function that write all bytes
    fn write_bytes(&mut self, bytes: &[u8]) -> error::Result<()>;

    /// Function that write bytes plus a '\0' at end
    fn write_ascii(&mut self, ascii: &[u8]) -> error::Result<()> {
        self.write_bytes(ascii)?;
        self.write_bytes(&[b'\0'])
    }

    /// Function that write one bit and convert it as bool
    fn write_bool(&mut self, value: &bool) -> error::Result<()> {
        self.write_bytes(&((*value as u8).to_be_bytes()))
    }

    /// Function that write u8
    fn write_u8(&mut self, value: &u8) -> error::Result<()> {
        self.write_bytes(&value.to_be_bytes())
    }

    /// Function that write u16
    fn write_u16(&mut self, value: &u16) -> error::Result<()> {
        self.write_bytes(&value.to_be_bytes())
    }

    /// Function that write u32
    fn write_u32(&mut self, value: &u32) -> error::Result<()> {
        self.write_bytes(&value.to_be_bytes())
    }

    /// Function that write u64
    fn write_u64(&mut self, value: &u64) -> error::Result<()> {
        self.write_bytes(&value.to_be_bytes())
    }

    /// Function that write i64
    fn write_i64(&mut self, value: &i64) -> error::Result<()> {
        self.write_bytes(&value.to_be_bytes())
    }
}

impl<T> KffWrite for T
where
    T: std::io::Write,
{
    fn write_bytes(&mut self, bytes: &[u8]) -> error::Result<()> {
        self.write_all(bytes)?;

        Ok(())
    }
}

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

    #[test]
    fn write_bytes() -> error::Result<()> {
        let mut writer = Vec::new();

        writer.write_bytes(b"Lorem")?;

        assert_eq!(writer, b"Lorem");

        Ok(())
    }

    #[test]
    fn write_ascii() -> error::Result<()> {
        let mut writer = Vec::new();

        writer.write_ascii(b"Lorem")?;

        assert_eq!(writer, &[b'L', b'o', b'r', b'e', b'm', 0]);

        Ok(())
    }

    #[test]
    fn write_bool() -> error::Result<()> {
        let mut writer = Vec::new();

        writer.write_bool(&true)?;
        writer.write_bool(&false)?;

        assert_eq!(writer, &[1, 0]);

        Ok(())
    }

    #[test]
    fn write_u8() -> error::Result<()> {
        let mut writer = Vec::new();

        writer.write_u8(&1)?;
        writer.write_u8(&128)?;
        writer.write_u8(&130)?;

        assert_eq!(writer, &[1, 128, 130]);

        Ok(())
    }

    #[test]
    fn write_u16() -> error::Result<()> {
        let mut writer = Vec::new();

        writer.write_u16(&250)?;
        writer.write_u16(&500)?;

        assert_eq!(writer, &[0, 250, 1, 244]);

        Ok(())
    }

    #[test]
    fn write_u32() -> error::Result<()> {
        let mut writer = Vec::new();

        writer.write_u32(&3511)?;
        writer.write_u32(&511110)?;

        assert_eq!(writer, &[0, 0, 13, 183, 0, 7, 204, 134]);

        Ok(())
    }

    #[test]
    fn write_u64() -> error::Result<()> {
        let mut writer = Vec::new();

        writer.write_u64(&35191823831)?;
        writer.write_u64(&444799335191823831)?;

        assert_eq!(
            writer,
            &[0, 0, 0, 8, 49, 152, 157, 215, 6, 44, 62, 163, 130, 112, 69, 215]
        );

        Ok(())
    }
}