noodles_cram/
file_definition.rs

1//! CRAM file definition and fields.
2
3mod version;
4
5pub use self::version::Version;
6
7/// A CRAM file definition.
8///
9/// The CRAM file definition holds the format version and file ID. See § 6 File definition
10/// (2020-06-22).
11#[derive(Clone, Default, Debug, Eq, PartialEq)]
12pub struct FileDefinition {
13    version: Version,
14    file_id: [u8; 20],
15}
16
17impl FileDefinition {
18    /// Creates a file definition.
19    ///
20    /// # Examples
21    ///
22    /// ```
23    /// use noodles_cram::{file_definition::Version, FileDefinition};
24    /// let file_definition = FileDefinition::new(Version::new(3, 0), [0; 20]);
25    /// ```
26    pub fn new(version: Version, file_id: [u8; 20]) -> Self {
27        Self { version, file_id }
28    }
29
30    /// Returns the file version.
31    ///
32    /// This is also called the (major and minor) format number.
33    ///
34    /// # Examples
35    ///
36    /// ```
37    /// use noodles_cram::{file_definition::Version, FileDefinition};
38    /// let file_definition = FileDefinition::new(Version::new(3, 0), [0; 20]);
39    /// assert_eq!(file_definition.version(), Version::new(3, 0));
40    /// ```
41    pub fn version(&self) -> Version {
42        self.version
43    }
44
45    /// Returns the file ID.
46    ///
47    /// The file ID has a fixed length of 20 bytes. It can be any arbitrary identifier, e.g., the
48    /// file name or a 160-bit checksum.
49    ///
50    /// # Examples
51    ///
52    /// ```
53    /// use noodles_cram::{file_definition::Version, FileDefinition};
54    /// let file_definition = FileDefinition::new(Version::new(3, 0), [0; 20]);
55    /// assert_eq!(file_definition.file_id(), [0; 20]);
56    /// ```
57    pub fn file_id(&self) -> &[u8] {
58        &self.file_id
59    }
60}
61
62#[cfg(test)]
63mod tests {
64    use super::*;
65
66    #[test]
67    fn test_default() {
68        let actual = FileDefinition::default();
69        let expected = FileDefinition::new(Version::new(3, 0), [0; 20]);
70        assert_eq!(actual, expected);
71    }
72}
noodles_cram/file_definition.rs

noodles_cram/
file_definition.rs
