noodles-sam 0.85.0

Sequence Alignment/Map (SAM) format reader and writer
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

use std::{error, fmt};

use bstr::BString;

/// An error returned when a SAM header record comment value fails to parse.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum ParseError {
    /// The delimiter is invalid.
    InvalidDelimiter,
}

impl error::Error for ParseError {}

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidDelimiter => write!(f, "invalid delimiter"),
        }
    }
}

pub(super) fn parse_comment(src: &mut &[u8]) -> Result<BString, ParseError> {
    consume_delimiter(src)?;
    let (buf, rest) = src.split_at(src.len());
    *src = rest;
    Ok(buf.into())
}

fn consume_delimiter(src: &mut &[u8]) -> Result<(), ParseError> {
    const PREFIX: u8 = b'\t';

    if let Some(&PREFIX) = src.split_off_first() {
        Ok(())
    } else {
        Err(ParseError::InvalidDelimiter)
    }
}

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

    #[test]
    fn test_parse_comment() {
        let mut src = &b"\tnoodles"[..];
        assert_eq!(parse_comment(&mut src), Ok(BString::from("noodles")));

        let mut src = &b"noodles"[..];
        assert_eq!(parse_comment(&mut src), Err(ParseError::InvalidDelimiter));
    }
}