caff-archive 0.1.0

a library for manipulating CAFF archives
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

use crate::prelude::*;

#[derive(Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(test, derive(Arbitrary))]
pub struct Version {
  pub major: u8,
  pub minor: u8,
  pub patch: u8,
}

impl From<[u8; 3]> for Version {
  fn from([major, minor, patch]: [u8; 3]) -> Self {
    Self { major, minor, patch }
  }
}

impl From<Version> for [u8; 3] {
  fn from(Version { major, minor, patch }: Version) -> Self {
    [major, minor, patch]
  }
}

impl std::fmt::Debug for Version {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    f.write_fmt(format_args!("{}.{}.{}", self.major, self.minor, self.patch))
  }
}

impl Version {
  pub fn new(major: u8, minor: u8, patch: u8) -> Self {
    [major, minor, patch].into()
  }

  pub fn is_empty(&self) -> bool {
    self.major == 0 && self.minor == 0 && self.patch == 0
  }

  pub fn read<R: Read + Seek>(reader: &mut R) -> Result<Self> {
    reader.trace(|reader| {
      let major = reader.read_u8()?;
      let minor = reader.read_u8()?;
      let patch = reader.read_u8()?;

      let value = Self { major, minor, patch };

      #[cfg(feature = "discovery")]
      if !value.is_empty() {
        log::info!("read value={value:?}");
      }

      Ok(value)
    })
  }

  pub fn write<W: Write + Seek>(self, writer: &mut W) -> Result<()> {
    writer.trace(|writer| {
      let Self { major, minor, patch } = self;

      writer.write_u8(major)?;
      writer.write_u8(minor)?;
      writer.write_u8(patch)?;

      Ok(())
    })
  }
}

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

  #[proptest]
  fn roundtrip(expected: Version) {
    let mut buffer = Cursor::new(Vec::new());

    expected.write(&mut buffer).unwrap();
    buffer.rewind().unwrap();
    let actual = Version::read(&mut buffer).unwrap();

    assert_eq!(expected, actual);
  }

  #[proptest]
  fn from_bytes(value: [u8; 3]) {
    Version::from(value);
  }

  #[proptest]
  fn into_bytes(value: Version) {
    <[u8; 3]>::from(value);
  }
}