xtool 0.0.16

Amazing Tools
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

/// Allows conversions between byte arrays and other types.
///
/// # Example
///
/// ```rust
/// use xtool::tftp::core::Convert;
///
/// assert_eq!(Convert::to_u16(&[0x01, 0x02]).unwrap(), 0x0102);
///
/// let (result, index) = Convert::to_string(b"hello world\0", 0).unwrap();
/// assert_eq!(result, "hello world");
/// assert_eq!(index, 11);
/// ```
pub struct Convert;

impl Convert {
    /// Converts a [`u8`] slice to a [`u16`].
    pub fn to_u16(buf: &[u8]) -> anyhow::Result<u16> {
        if buf.len() < 2 {
            Err(anyhow::anyhow!("Error when converting to u16"))
        } else {
            Ok(((buf[0] as u16) << 8) + buf[1] as u16)
        }
    }

    /// Converts a zero-terminated [`u8`] slice to a [`String`], and returns the
    /// size of the [`String`]. Useful for TFTP packet conversions.
    pub fn to_string(buf: &[u8], start: usize) -> anyhow::Result<(String, usize)> {
        match buf[start..].iter().position(|&b| b == 0x00) {
            Some(index) => Ok((
                String::from_utf8(buf[start..start + index].to_vec())?,
                index + start,
            )),
            None => Err(anyhow::anyhow!("Invalid string")),
        }
    }
}

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

    #[test]
    fn converts_to_u16() {
        assert_eq!(Convert::to_u16(&[0x01, 0x02]).unwrap(), 0x0102);
        assert_eq!(Convert::to_u16(&[0x00, 0x02]).unwrap(), 0x0002);
        assert_eq!(Convert::to_u16(&[0xfe, 0xdc, 0xba]).unwrap(), 0xfedc);
    }

    #[test]
    fn returns_error_on_short_array() {
        assert!(Convert::to_u16(&[0x01]).is_err());
        assert!(Convert::to_u16(&[]).is_err());
    }

    #[test]
    fn converts_to_string() {
        let (result, index) = Convert::to_string(b"hello world\0", 0).unwrap();
        assert_eq!(result, "hello world");
        assert_eq!(index, 11);

        let (result, index) = Convert::to_string(b"hello\0world", 0).unwrap();
        assert_eq!(result, "hello");
        assert_eq!(index, 5);

        let (result, index) = Convert::to_string(b"\0hello world", 0).unwrap();
        assert_eq!(result, "");
        assert_eq!(index, 0);
    }

    #[test]
    fn converts_to_string_with_index() {
        let (result, index) = Convert::to_string(b"hello\0world\0", 0).unwrap();
        assert_eq!(result, "hello");
        assert_eq!(index, 5);

        let (result, index) = Convert::to_string(b"hello\0world\0", 5).unwrap();
        assert_eq!(result, "");
        assert_eq!(index, 5);

        let (result, index) = Convert::to_string(b"hello\0world\0", 6).unwrap();
        assert_eq!(result, "world");
        assert_eq!(index, 11);
    }
}