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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
use std::{
io::{self, BufRead, Read, Seek},
iter, str,
};
use noodles_bgzf as bgzf;
use noodles_core::Region;
use noodles_csi::{self as csi, BinningIndex};
use super::{Line, Record};
/// A GTF reader.
pub struct Reader<R> {
inner: R,
}
impl<R> Reader<R>
where
R: BufRead,
{
/// Creates a GTF reader.
///
/// # Examples
///
/// ```
/// use noodles_gtf as gtf;
/// let data = [];
/// let reader = gtf::Reader::new(&data[..]);
/// ```
pub fn new(inner: R) -> Self {
Self { inner }
}
/// Reads a raw GTF line.
///
/// # Examples
///
/// ```
/// # use std::io;
/// use noodles_gtf as gtf;
///
/// let data = b"sq0\tNOODLES\tgene\t8\t13\t.\t+\t.\tgene_id \"ndls0\"; transcript_id \"ndls0\";";
/// let mut reader = gtf::Reader::new(&data[..]);
///
/// let mut buf = String::new();
/// reader.read_line(&mut buf)?;
///
/// assert_eq!(
/// buf,
/// "sq0\tNOODLES\tgene\t8\t13\t.\t+\t.\tgene_id \"ndls0\"; transcript_id \"ndls0\";"
/// );
/// # Ok::<_, io::Error>(())
/// ```
pub fn read_line(&mut self, buf: &mut String) -> io::Result<usize> {
read_line(&mut self.inner, buf)
}
/// Returns an iterator over lines starting from the current stream position.
///
/// # Examples
///
/// ```
/// # use std::io;
/// use noodles_gtf as gtf;
///
/// let data = b"##format: gtf
/// sq0\tNOODLES\tgene\t8\t13\t.\t+\t.\tgene_id \"g0\"; transcript_id \"t0\";
/// ";
/// let mut reader = gtf::Reader::new(&data[..]);
///
/// let mut lines = reader.lines();
///
/// let line = lines.next().transpose()?;
/// assert_eq!(line, Some(gtf::Line::Comment(String::from("#format: gtf"))));
///
/// let line = lines.next().transpose()?;
/// assert!(matches!(line, Some(gtf::Line::Record(_))));
///
/// assert!(lines.next().is_none());
/// # Ok::<_, io::Error>(())
/// ```
pub fn lines(&mut self) -> impl Iterator<Item = io::Result<Line>> + '_ {
let mut buf = String::new();
iter::from_fn(move || {
buf.clear();
match self.read_line(&mut buf) {
Ok(0) => None,
Ok(_) => Some(
buf.parse()
.map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e)),
),
Err(e) => Some(Err(e)),
}
})
}
/// Returns an iterator over records starting from the current stream position.
///
/// # Examples
///
/// ```
/// # use std::io;
/// use noodles_core::Position;
/// use noodles_gtf as gtf;
///
/// let data = b"##format: gtf
/// sq0\tNOODLES\tgene\t8\t13\t.\t+\t.\tgene_id \"g0\"; transcript_id \"t0\";
/// ";
/// let mut reader = gtf::Reader::new(&data[..]);
///
/// let mut records = reader.records();
///
/// let record = records.next().transpose()?;
/// assert_eq!(record.map(|r| r.start()), Position::new(8));
/// // ...
///
/// assert!(records.next().is_none());
/// # Ok::<_, io::Error>(())
/// ```
pub fn records(&mut self) -> impl Iterator<Item = io::Result<Record>> + '_ {
let mut lines = self.lines();
iter::from_fn(move || loop {
match lines.next()? {
Ok(Line::Record(r)) => return Some(Ok(r)),
Ok(_) => {}
Err(e) => return Some(Err(e)),
}
})
}
}
impl<R> Reader<bgzf::Reader<R>>
where
R: Read + Seek,
{
/// Returns an iterator over records that intersects the given region.
pub fn query<'r, I>(
&'r mut self,
index: &I,
region: &'r Region,
) -> io::Result<impl Iterator<Item = io::Result<Record>> + 'r>
where
I: BinningIndex,
{
let header = index
.header()
.ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "missing index header"))?;
let region_name = str::from_utf8(region.name())
.map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
let reference_sequence_id = header
.reference_sequence_names()
.get_index_of(region_name)
.ok_or_else(|| {
io::Error::new(
io::ErrorKind::InvalidInput,
"missing reference sequence name",
)
})?;
let chunks = index.query(reference_sequence_id, region.interval())?;
let records = csi::io::Query::new(&mut self.inner, chunks)
.indexed_records(header)
.filter_by_region(region)
.map(|result| {
result.and_then(|r| {
r.as_ref()
.parse()
.map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))
})
});
Ok(records)
}
}
fn read_line<R>(reader: &mut R, buf: &mut String) -> io::Result<usize>
where
R: BufRead,
{
const LINE_FEED: char = '\n';
const CARRIAGE_RETURN: char = '\r';
match reader.read_line(buf) {
Ok(0) => Ok(0),
Ok(n) => {
if buf.ends_with(LINE_FEED) {
buf.pop();
if buf.ends_with(CARRIAGE_RETURN) {
buf.pop();
}
}
Ok(n)
}
Err(e) => Err(e),
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_read_line() -> io::Result<()> {
fn t(buf: &mut String, mut src: &[u8], expected: &str) -> io::Result<()> {
buf.clear();
read_line(&mut src, buf)?;
assert_eq!(buf, expected);
Ok(())
}
let mut buf = String::new();
t(&mut buf, b"noodles\n", "noodles")?;
t(&mut buf, b"noodles\r\n", "noodles")?;
t(&mut buf, b"noodles", "noodles")?;
Ok(())
}
}