Struct Header

pub struct Header { /* private fields */ }

A BAM header.

Implementations

impl Header

pub fn new() -> Self

Create a new header.

pub fn from_template(header: &HeaderView) -> Self

pub fn push_record(&mut self, record: &HeaderRecord<'_>) -> &mut Self

Add a record to the header.

pub fn push_comment(&mut self, comment: &[u8]) -> &mut Self

Add a comment to the header.

pub fn to_bytes(&self) -> Vec<u8>

pub fn to_hashmap(&self) -> HashMap<String, Vec<LinearMap<String, String>>>

This returns a header as a HashMap. Comment lines starting with “@CO” will NOT be included in the HashMap. Comment lines can be obtained by the comments function.

pub fn comments(&self) -> impl Iterator<Item = Cow<'_, str>>

Returns an iterator of comment lines.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Header

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.