Struct noodles_sam::header::Parser

pub struct Parser { /* private fields */ }

A SAM header parser.

Implementations

impl Parser

pub fn parse_partial(&mut self, src: &[u8]) -> Result<(), ParseError>

Parses and adds a raw record to the header.

Examples

use noodles_sam as sam;
let mut parser = sam::header::Parser::default();
parser.parse_partial(b"@HD\tVN:1.6")?;

pub fn finish(self) -> Header

Builds the SAM header.

Examples

use noodles_sam as sam;
let parser = sam::header::Parser::default();
let header = parser.finish();
assert!(header.is_empty());

Trait Implementations

impl Default for Parser

fn default() -> Parser

Returns the “default value” for a type.