Merge pull request #4 from jancrichter/patch-1

add bcf_reader::Record.id()

src/lib.rs

@@ -1003,6 +1003,41 @@ impl Record {
         self.pos
     }
 
+    /// get variant ID as &str
+    /// Example:
+    /// ```
+    /// use bcf_reader::*;
+    /// // read data generated by bcftools
+    /// // bcftools query -f '%ID\n' test4.bcf | bgzip -c > test_id.gz
+    /// let mut id_str = String::new();
+    /// 
+    /// smart_reader("testdata/test_id.gz")
+    ///     .read_to_string(&mut id_str)
+    ///     .unwrap();
+    /// 
+    /// // read data via bcf-reader
+    /// let mut f = smart_reader("testdata/test.bcf");
+    /// let _s = read_header(&mut f);
+    /// let mut record = Record::default();
+    /// let mut id_str2 = Vec::<u8>::new();
+    /// use std::io::Write;
+    /// while let Ok(_) = record.read(&mut f) {
+    ///     let id = if record.id().is_empty() {
+    ///         "."
+    ///     } else {
+    ///         record.id()
+    ///     };
+    ///     write!(id_str2, "{}\n", id).unwrap();
+    /// }
+    /// let id_str2 = String::from_utf8(id_str2).unwrap();
+    /// // compare bcftools results and bcf-reader results
+    /// assert_eq!(id_str, id_str2);
+    /// 
+    /// ```
+    pub fn id(&self) -> &str {
+        std::str::from_utf8(&self.buf_shared[self.id.start..self.id.end]).unwrap()
+    }
+
     /// Returns the ranges of bytes in buf_shared for all alleles in the record.
     /// Example:
     /// ```